← Back to branch summary

~michaelforrest/use-case-mapper/trunk

« back to all changes in this revision

Viewing changes to vendor/rails/railties/lib/tasks/documentation.rake

  • Committer: Richard Lee (Canonical)
  • Date: 2010-10-15 15:17:58 UTC
  • mfrom: (190.1.3 use-case-mapper)
  • Revision ID: richard.lee@canonical.com-20101015151758-wcvmfxrexsongf9d
Merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
    require File.join(RAILTIES_PATH, "guides/rails_guides")
58
 
    RailsGuides::Generator.new(File.join(RAILS_ROOT, "doc/guides")).generate
59
 
  end
60
 
 
61
 
  namespace :plugins do
62
 
    # Define doc tasks for each plugin
63
 
    plugins.each do |plugin|
64
 
      desc "Generate documentation for the #{plugin} plugin"
65
 
      task(plugin => :environment) do
66
 
        plugin_base   = "vendor/plugins/#{plugin}"
67
 
        options       = []
68
 
        files         = Rake::FileList.new
69
 
        options << "-o doc/plugins/#{plugin}"
70
 
        options << "--title '#{plugin.titlecase} Plugin Documentation'"
71
 
        options << '--line-numbers' << '--inline-source'
72
 
        options << '--charset' << 'utf-8'
73
 
        options << '-T html'
74
 
 
75
 
        files.include("#{plugin_base}/lib/**/*.rb")
76
 
        if File.exist?("#{plugin_base}/README")
77
 
          files.include("#{plugin_base}/README")    
78
 
          options << "--main '#{plugin_base}/README'"
79
 
        end
80
 
        files.include("#{plugin_base}/CHANGELOG") if File.exist?("#{plugin_base}/CHANGELOG")
81
 
 
82
 
        options << files.to_s
83
 
 
84
 
        sh %(rdoc #{options * ' '})
85
 
      end
86
 
    end
87
 
  end
88
 
end