aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/tasks/documentation.rake
diff options
context:
space:
mode:
authorNathaniel Bibler <git@nathanielbibler.com>2008-08-29 23:36:16 -0400
committerJeremy Kemper <jeremy@bitsweat.net>2008-08-29 21:04:04 -0700
commitefa6620a2a7b8ae7b42664ab81faef7df1368939 (patch)
treea84e204bd322791b92ea69af629e2ce953406aec /railties/lib/tasks/documentation.rake
parent16b9a554db7e1bf3f5f224cdc5b4d27480e053ff (diff)
downloadrails-efa6620a2a7b8ae7b42664ab81faef7df1368939.tar.gz
rails-efa6620a2a7b8ae7b42664ab81faef7df1368939.tar.bz2
rails-efa6620a2a7b8ae7b42664ab81faef7df1368939.zip
Added optional rake doc:app TITLE environment parameter
[#939 state:resolved] Signed-off-by: Jeremy Kemper <jeremy@bitsweat.net>
Diffstat (limited to 'railties/lib/tasks/documentation.rake')
-rw-r--r--railties/lib/tasks/documentation.rake4
1 files changed, 2 insertions, 2 deletions
diff --git a/railties/lib/tasks/documentation.rake b/railties/lib/tasks/documentation.rake
index f4927a0ef1..4ef838626a 100644
--- a/railties/lib/tasks/documentation.rake
+++ b/railties/lib/tasks/documentation.rake
@@ -1,9 +1,9 @@
namespace :doc do
- desc "Generate documentation for the application. Set custom template with TEMPLATE=/path/to/rdoc/template.rb"
+ 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'
rdoc.template = ENV['template'] if ENV['template']
- rdoc.title = "Rails Application Documentation"
+ 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')