aboutsummaryrefslogtreecommitdiffstats
path: root/railties
diff options
context:
space:
mode:
authorVijay Dev <vijaydev.cse@gmail.com>2011-06-16 12:29:47 +0530
committerVijay Dev <vijaydev.cse@gmail.com>2011-06-16 12:29:47 +0530
commitbfb022adae4b8f6ba35872531bc5774b72fbe467 (patch)
tree6fe7a11500a16cd5f3ef6833c1bc073d2c611aae /railties
parentcbf2af1e81fcae8c0ee4472e7bb0620c77786106 (diff)
downloadrails-bfb022adae4b8f6ba35872531bc5774b72fbe467.tar.gz
rails-bfb022adae4b8f6ba35872531bc5774b72fbe467.tar.bz2
rails-bfb022adae4b8f6ba35872531bc5774b72fbe467.zip
document doc:* rake tasks
Diffstat (limited to 'railties')
-rw-r--r--railties/guides/source/command_line.textile8
1 files changed, 7 insertions, 1 deletions
diff --git a/railties/guides/source/command_line.textile b/railties/guides/source/command_line.textile
index 8c78cab84f..b42fdac7e4 100644
--- a/railties/guides/source/command_line.textile
+++ b/railties/guides/source/command_line.textile
@@ -398,7 +398,13 @@ More information about migrations can be found in the "Migrations":migrations.ht
h4. +doc+
-If you want to strip out or rebuild any of the Rails documentation (including this guide!), the +doc:+ namespace has the tools. Stripping documentation is mainly useful for slimming your codebase, like if you're writing a Rails application for an embedded platform.
+The +doc:+ namespace has the tools to generate documentation for your app, API documentation, guides. Documentation can also be stripped which is mainly useful for slimming your codebase, like if you're writing a Rails application for an embedded platform.
+
+* +rake doc:app+ generates documentation for your application in +doc/app+.
+* +rake doc:guides+ generates Rails guides in +doc/guides+.
+* +rake doc:rails+ generates API documentation for Rails in +doc/api+.
+* +rake doc:plugins+ generates API documentation for all the plugins installed in the application in +doc/plugins+.
+* +rake doc:clobber_plugins+ removes the generated documentation for all plugins.
h4. +notes+