9e909d5be3
Update Bundler to 1.0.15. Update Rails to 2.3.12. Update rails_xss plugin. The latter two were the source of a considerable amount of grief, as rails_xss is now MUCH stricter about what string methods can be used. Also made it possible to use rake 0.9.x with Instiki. But you probably REALLY want to use ruby bundle exec rake ... instead of just saying rake ....
89 lines
3.9 KiB
Ruby
89 lines
3.9 KiB
Ruby
namespace :doc do
|
|
desc "Generate documentation for the application. Set custom template with TEMPLATE=/path/to/rdoc/template.rb or title with TITLE=\"Custom Title\""
|
|
RDoc::Task.new("app") { |rdoc|
|
|
rdoc.rdoc_dir = 'doc/app'
|
|
rdoc.template = ENV['template'] if ENV['template']
|
|
rdoc.title = ENV['title'] || "Rails Application Documentation"
|
|
rdoc.options << '--line-numbers' << '--inline-source'
|
|
rdoc.options << '--charset' << 'utf-8'
|
|
rdoc.rdoc_files.include('doc/README_FOR_APP')
|
|
rdoc.rdoc_files.include('app/**/*.rb')
|
|
rdoc.rdoc_files.include('lib/**/*.rb')
|
|
}
|
|
|
|
desc "Generate documentation for the Rails framework"
|
|
RDoc::Task.new("rails") { |rdoc|
|
|
rdoc.rdoc_dir = 'doc/api'
|
|
rdoc.template = "#{ENV['template']}.rb" if ENV['template']
|
|
rdoc.title = "Rails Framework Documentation"
|
|
rdoc.options << '--line-numbers' << '--inline-source'
|
|
rdoc.rdoc_files.include('README')
|
|
rdoc.rdoc_files.include('vendor/rails/railties/CHANGELOG')
|
|
rdoc.rdoc_files.include('vendor/rails/railties/MIT-LICENSE')
|
|
rdoc.rdoc_files.include('vendor/rails/railties/README')
|
|
rdoc.rdoc_files.include('vendor/rails/railties/lib/{*.rb,commands/*.rb,rails_generator/*.rb}')
|
|
rdoc.rdoc_files.include('vendor/rails/activerecord/README')
|
|
rdoc.rdoc_files.include('vendor/rails/activerecord/CHANGELOG')
|
|
rdoc.rdoc_files.include('vendor/rails/activerecord/lib/active_record/**/*.rb')
|
|
rdoc.rdoc_files.exclude('vendor/rails/activerecord/lib/active_record/vendor/*')
|
|
rdoc.rdoc_files.include('vendor/rails/activeresource/README')
|
|
rdoc.rdoc_files.include('vendor/rails/activeresource/CHANGELOG')
|
|
rdoc.rdoc_files.include('vendor/rails/activeresource/lib/active_resource.rb')
|
|
rdoc.rdoc_files.include('vendor/rails/activeresource/lib/active_resource/*')
|
|
rdoc.rdoc_files.include('vendor/rails/actionpack/README')
|
|
rdoc.rdoc_files.include('vendor/rails/actionpack/CHANGELOG')
|
|
rdoc.rdoc_files.include('vendor/rails/actionpack/lib/action_controller/**/*.rb')
|
|
rdoc.rdoc_files.include('vendor/rails/actionpack/lib/action_view/**/*.rb')
|
|
rdoc.rdoc_files.include('vendor/rails/actionmailer/README')
|
|
rdoc.rdoc_files.include('vendor/rails/actionmailer/CHANGELOG')
|
|
rdoc.rdoc_files.include('vendor/rails/actionmailer/lib/action_mailer/base.rb')
|
|
rdoc.rdoc_files.include('vendor/rails/activesupport/README')
|
|
rdoc.rdoc_files.include('vendor/rails/activesupport/CHANGELOG')
|
|
rdoc.rdoc_files.include('vendor/rails/activesupport/lib/active_support/**/*.rb')
|
|
}
|
|
|
|
plugins = FileList['vendor/plugins/**'].collect { |plugin| File.basename(plugin) }
|
|
|
|
desc "Generate documentation for all installed plugins"
|
|
task :plugins => plugins.collect { |plugin| "doc:plugins:#{plugin}" }
|
|
|
|
desc "Remove plugin documentation"
|
|
task :clobber_plugins do
|
|
rm_rf 'doc/plugins' rescue nil
|
|
end
|
|
|
|
desc "Generate Rails guides"
|
|
task :guides do
|
|
require File.join(RAILTIES_PATH, "guides/rails_guides")
|
|
RailsGuides::Generator.new(File.join(RAILS_ROOT, "doc/guides")).generate
|
|
end
|
|
|
|
namespace :plugins do
|
|
# Define doc tasks for each plugin
|
|
plugins.each do |plugin|
|
|
desc "Generate documentation for the #{plugin} plugin"
|
|
task(plugin => :environment) do
|
|
plugin_base = "vendor/plugins/#{plugin}"
|
|
options = []
|
|
files = Rake::FileList.new
|
|
options << "-o doc/plugins/#{plugin}"
|
|
options << "--title '#{plugin.titlecase} Plugin Documentation'"
|
|
options << '--line-numbers' << '--inline-source'
|
|
options << '--charset' << 'utf-8'
|
|
options << '-T html'
|
|
|
|
files.include("#{plugin_base}/lib/**/*.rb")
|
|
if File.exist?("#{plugin_base}/README")
|
|
files.include("#{plugin_base}/README")
|
|
options << "--main '#{plugin_base}/README'"
|
|
end
|
|
files.include("#{plugin_base}/CHANGELOG") if File.exist?("#{plugin_base}/CHANGELOG")
|
|
|
|
options << files.to_s
|
|
|
|
sh %(rdoc #{options * ' '})
|
|
end
|
|
end
|
|
end
|
|
end
|