More than just a new RDoc template
Ruby HTML CSS JavaScript
Pull request Compare This branch is 63 commits ahead of raggi:master.
Latest commit c232b18 Oct 12, 2016 @jeremyevans jeremyevans Remove target="docwin" from links, Bump version to 1.0.1
Having target on every link breaks expected behavior when a
specific frame is linked to.  It's not actually needed to set
target="docwin" on links at all, because the three navigation
frames all use target="base" in the base tag, which sets the
default target for all links in that frame.


Hanna Nouveau — a better RDoc template, now for RDoc 4.

Based on the original Hanna by Mislav.

Hanna is an RDoc generator 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.

Hanna gem is available from

gem install hanna-nouveau

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.

  3. Erik Hollensbe a serious refactoring and up to date with RDoc 2.5.x and 3.x, now named 'hanna-nouveau'.

  4. James Tucker minor cleanups for Erik.

  5. Jeremy Evans RDoc 4 support, maintenance since 2014.


rdoc -o doc -f hanna lib/*.rb

An alternative is to set the `RDOCOPT` environment variable:

RDOCOPT="-f hanna"

This will make RDoc always use hanna-nouveau unless it is explicitly overridden.

Integrating with RubyGems

Another neat trick is to put the following line in your .gemrc, this will make RubyGems use Hanna for all rdoc generation:

rdoc: -f hanna

This will make RubyGems use Hanna when generating documentation for installed gems. Remember, if you wish to have all your gems be formatted in hanna:

gem rdoc --all --overwrite

The first time. To easily browse your newly created documentation, use:

gem server

Rake task

For repeated generation of API docs, it's better to set up a Rake task. Simply add the hanna format argument to your RDoc::Task options:

gem 'rdoc'
require 'rdoc/task' do |rdoc|
  # this only works with RDoc 3.1 or greater
  rdoc.generator = 'hanna'
  # this is what you use pre RDoc 3.1:
  rdoc.options.push '-f', 'hanna'

Tip: you can do this in the Rakefile of your Rails project before running `rake doc:rails`.

Here is an example of a task for the rdbi library:

gem 'rdoc'
require 'rdoc/task' do |rdoc|
  version = File.exist?('VERSION') ?'VERSION') : ""

  rdoc.generator = 'hanna'
  rdoc.main = 'README.rdoc'
  rdoc.rdoc_dir = 'rdoc'
  rdoc.title = "RDBI #{version} Documentation"

Modification to RDoc

Hanna makes a small modification to RDoc to generate more friendly documentation. It changes label lists to use a table instead of a description list, since it is very difficult to get visually appealing styling for description lists without cutting corners (like using fixed widths).