vendor/rails/railties/lib/tasks/documentation.rake

   1 namespace :doc do
   2   desc "Generate documentation for the application. Set custom template with TEMPLATE=/path/to/rdoc/template.rb or title with TITLE=\"Custom Title\""
   3   Rake::RDocTask.new("app") { |rdoc|
   4     rdoc.rdoc_dir = 'doc/app'
   5     rdoc.template = ENV['template'] if ENV['template']
   6     rdoc.title    = ENV['title'] || "Rails Application Documentation"
   7     rdoc.options << '--line-numbers' << '--inline-source'
   8     rdoc.options << '--charset' << 'utf-8'
   9     rdoc.rdoc_files.include('doc/README_FOR_APP')
  10     rdoc.rdoc_files.include('app/**/*.rb')
  11     rdoc.rdoc_files.include('lib/**/*.rb')
  12   }
  13
  14   desc "Generate documentation for the Rails framework"
  15   Rake::RDocTask.new("rails") { |rdoc|
  16     rdoc.rdoc_dir = 'doc/api'
  17     rdoc.template = "#{ENV['template']}.rb" if ENV['template']
  18     rdoc.title    = "Rails Framework Documentation"
  19     rdoc.options << '--line-numbers' << '--inline-source'
  20     rdoc.rdoc_files.include('README')
  21     rdoc.rdoc_files.include('vendor/rails/railties/CHANGELOG')
  22     rdoc.rdoc_files.include('vendor/rails/railties/MIT-LICENSE')
  23     rdoc.rdoc_files.include('vendor/rails/railties/README')
  24     rdoc.rdoc_files.include('vendor/rails/railties/lib/{*.rb,commands/*.rb,rails_generator/*.rb}')
  25     rdoc.rdoc_files.include('vendor/rails/activerecord/README')
  26     rdoc.rdoc_files.include('vendor/rails/activerecord/CHANGELOG')
  27     rdoc.rdoc_files.include('vendor/rails/activerecord/lib/active_record/**/*.rb')
  28     rdoc.rdoc_files.exclude('vendor/rails/activerecord/lib/active_record/vendor/*')
  29     rdoc.rdoc_files.include('vendor/rails/activeresource/README')
  30     rdoc.rdoc_files.include('vendor/rails/activeresource/CHANGELOG')
  31     rdoc.rdoc_files.include('vendor/rails/activeresource/lib/active_resource.rb')
  32     rdoc.rdoc_files.include('vendor/rails/activeresource/lib/active_resource/*')
  33     rdoc.rdoc_files.include('vendor/rails/actionpack/README')
  34     rdoc.rdoc_files.include('vendor/rails/actionpack/CHANGELOG')
  35     rdoc.rdoc_files.include('vendor/rails/actionpack/lib/action_controller/**/*.rb')
  36     rdoc.rdoc_files.include('vendor/rails/actionpack/lib/action_view/**/*.rb')
  37     rdoc.rdoc_files.include('vendor/rails/actionmailer/README')
  38     rdoc.rdoc_files.include('vendor/rails/actionmailer/CHANGELOG')
  39     rdoc.rdoc_files.include('vendor/rails/actionmailer/lib/action_mailer/base.rb')
  40     rdoc.rdoc_files.include('vendor/rails/activesupport/README')
  41     rdoc.rdoc_files.include('vendor/rails/activesupport/CHANGELOG')
  42     rdoc.rdoc_files.include('vendor/rails/activesupport/lib/active_support/**/*.rb')
  43   }
  44
  45   plugins = FileList['vendor/plugins/**'].collect { |plugin| File.basename(plugin) }
  46
  47   desc "Generate documentation for all installed plugins"
  48   task :plugins => plugins.collect { |plugin| "doc:plugins:#{plugin}" }
  49
  50   desc "Remove plugin documentation"
  51   task :clobber_plugins do
  52     rm_rf 'doc/plugins' rescue nil
  53   end
  54
  55   desc "Generate Rails guides"
  56   task :guides do
  57     source = File.join(RAILTIES_PATH, "doc/guides")
  58     destination = File.join(RAILS_ROOT, "doc/guides")
  59     FileUtils.rm_r(destination) if File.directory?(destination)
  60     FileUtils.mkdir(destination)
  61
  62     FileUtils.cp_r File.join(source, 'html/.'), File.join(destination)
  63     # Copy images and css files to html directory. These dirs are in .gitigore and shouldn't be source controlled.
  64     FileUtils.cp_r File.join(source, 'source/images'), File.join(destination)
  65     FileUtils.cp_r File.join(source, 'source/stylesheets'), File.join(destination, 'stylesheets')
  66   end
  67
  68   namespace :plugins do
  69     # Define doc tasks for each plugin
  70     plugins.each do |plugin|
  71       desc "Generate documentation for the #{plugin} plugin"
  72       task(plugin => :environment) do
  73         plugin_base   = "vendor/plugins/#{plugin}"
  74         options       = []
  75         files         = Rake::FileList.new
  76         options << "-o doc/plugins/#{plugin}"
  77         options << "--title '#{plugin.titlecase} Plugin Documentation'"
  78         options << '--line-numbers' << '--inline-source'
  79         options << '--charset' << 'utf-8'
  80         options << '-T html'
  81
  82         files.include("#{plugin_base}/lib/**/*.rb")
  83         if File.exist?("#{plugin_base}/README")
  84           files.include("#{plugin_base}/README")
  85           options << "--main '#{plugin_base}/README'"
  86         end
  87         files.include("#{plugin_base}/CHANGELOG") if File.exist?("#{plugin_base}/CHANGELOG")
  88
  89         options << files.to_s
  90
  91         sh %(rdoc #{options * ' '})
  92       end
  93     end
  94   end
  95 end