github/rails
1
1
Fork 0
mirror of https://github.com/github/rails.git synced 2026-04-26 03:00:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

Rake task for generating Rails documentation updated to support Bundler.

Browse Source 
Signed-off-by: José Valim <jose.valim@gmail.com>
This commit is contained in:
Rizwan Reza
2010-03-10 21:14:27 +03:30
committed by José Valim
parent 6c027443b0
commit 58796dcfc0
1 changed files with 33 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
railties/lib/rails/tasks/documentation.rake
View File

@@ -1,4 +1,8 @@
namespace :doc do
def gem_path(gem_name)
Bundler.load.specs.find{|s| s.name == gem_name}.full_gem_path
end
desc "Generate documentation for the application. Set custom template with TEMPLATE=/path/to/rdoc/template.rb or title with TITLE=\"Custom Title\""
Rake::RDocTask.new("app") { |rdoc|
rdoc.rdoc_dir = 'doc/app'
@@ -11,54 +15,42 @@ namespace :doc do
rdoc.rdoc_files.include('lib/**/*.rb')
}
desc 'Generate documentation for the Rails framework. Specify path with RAILS_PATH="/path/to/rails"'
path = ENV['RAILS_PATH']
unless path && File.directory?(path)
task :rails do
if path
$stderr.puts "Skipping doc:rails, missing Rails directory at #{path}"
else
$stderr.puts "Skipping doc:rails, RAILS_PATH environment variable is not set"
end
desc 'Generate documentation for the Rails framework.'
Rake::RDocTask.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')
%w(README CHANGELOG MIT-LICENSE lib/action_mailer/base.rb).each do |file|
rdoc.rdoc_files.include("#{gem_path('actionmailer')}/#{file}")
end
else
Rake::RDocTask.new("rails") { |rdoc|
version = "-#{Rails::VERSION::STRING}" unless ENV['RAILS_PATH']
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')
%w(README CHANGELOG lib/action_mailer/base.rb).each do |file|
rdoc.rdoc_files.include("#{path}/actionmailer#{version}/#{file}")
end
%w(README CHANGELOG MIT-LICENSE lib/action_controller/**/*.rb lib/action_view/**/*.rb).each do |file|
rdoc.rdoc_files.include("#{gem_path('actionpack')}/#{file}")
end
%w(README CHANGELOG lib/action_controller/**/*.rb lib/action_view/**/*.rb).each do |file|
rdoc.rdoc_files.include("#{path}/actionpack#{version}/#{file}")
end
%w(README CHANGELOG MIT-LICENSE lib/active_model/**/*.rb).each do |file|
rdoc.rdoc_files.include("#{gem_path('activemodel')}/#{file}")
end
%w(README CHANGELOG lib/active_model/**/*.rb).each do |file|
rdoc.rdoc_files.include("#{path}/activemodel#{version}/#{file}")
end
%w(README CHANGELOG lib/active_record/**/*.rb).each do |file|
rdoc.rdoc_files.include("#{gem_path('activerecord')}/#{file}")
end
%w(README CHANGELOG lib/active_record/**/*.rb).each do |file|
rdoc.rdoc_files.include("#{path}/activerecord#{version}/#{file}")
end
%w(README CHANGELOG lib/active_resource.rb lib/active_resource/*).each do |file|
rdoc.rdoc_files.include("#{gem_path('activeresource')}/#{file}")
end
%w(README CHANGELOG lib/active_resource.rb lib/active_resource/*).each do |file|
rdoc.rdoc_files.include("#{path}/activeresource#{version}/#{file}")
end
%w(README CHANGELOG lib/active_support/**/*.rb).each do |file|
rdoc.rdoc_files.include("#{gem_path('activesupport')}/#{file}")
end
%w(README CHANGELOG lib/active_support/**/*.rb).each do |file|
rdoc.rdoc_files.include("#{path}/activesupport#{version}/#{file}")
end
%w(README CHANGELOG MIT-LICENSE lib/{*.rb,commands/*.rb,generators/*.rb}).each do |file|
rdoc.rdoc_files.include("#{path}/railties#{version}/#{file}")
end
}
end
%w(README CHANGELOG lib/{*.rb,commands/*.rb,generators/*.rb}).each do |file|
rdoc.rdoc_files.include("#{gem_path('railties')}/#{file}")
end
}
plugins = FileList['vendor/plugins/**'].collect { |plugin| File.basename(plugin) }