Friday, July 30, 2010

RDoc opts

All Rails apps contain some pre-baked RDoc integration in the form of a doc directory, adoc/README_FOR_APP “main” doc file and some Rake tasks, which you can see below:

$ rake -T doc
rake doc:app              # Build the app HTML Files
rake doc:clobber_app      # Remove rdoc products
rake doc:clobber_plugins  # Remove plugin documentation
rake doc:clobber_rails    # Remove rdoc products
rake doc:plugins          # Generate documation for all installed plugins
rake doc:rails            # Build the rails HTML Files
rake doc:reapp            # Force a rebuild of the RDOC files
rake doc:rerails          # Force a rebuild of the RDOC files

No comments: