Showing posts with label RDoc. Show all posts
Showing posts with label RDoc. Show all posts

Wednesday, November 24, 2010

Hanna. A better RDoc template

Hanna is an RDoc template that scales. It's implemented in Haml, making the sources clean and readable. It's built with simplicity, beauty and ease of browsing in mind. (See more in the wiki.)
Hanna gem is available from Gemcutter:
gem install hanna
The template was created by Mislav and since then has seen contributions from:
  1. Tony Strauss, who participated from the early start and made tons of fixes and enhancements to the template;
  2. Hongli Lai with the search filter for methods.
https://github.com/mislav/hanna/tree/master

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