rdocのデフォルトのテンプレートが非常にダサくて、なかなか使いづらい。mislavのhannaを使えば、こんなにスタイリッシュになる：

おまけとして、簡単なメソッド検索もできます。また、テンプレート自体はhamlで書いていて、なかなか読みやすい。「スケールできる」ことが売りらしいけど、まぁ意味不明な自慢だよね。

インストール

1. rdoc 2.3.0をインストールする。現在のhannaはまだ最新rdocの2.4.xに対応していないからご注意ください。

      1  sudo gem install rdoc -v 2.3
      2  <<-- 
      3  2. githubをgemのsourceに追加
      4  shell-unix-generic>>
      5  gem source add http://gems.github.com
   
2. インストール

      1  gem install mislav-hanna
   
3. インストール済みのgemのrdocをhannaにする

      1  hanna --gems
   
4. これからインストールするgemのrdocもhannaにするため、.gemrcに以下の一行を追加する

      1  rdoc: --inline-source --line-numbers --format=html --template=hanna
   

ちなみに、今使っている.gemrcはこんな感じ：

   1  --- 
   2  :benchmark: false
   3  :update_sources: true
   4  :sources: 
   5  - http://gems.rubyforge.org/
   6  - http://gems.github.com
   7  :bulk_threshold: 1000
   8  :backtrace: false
   9  :verbose: true
  10  rdoc: --inline-source --line-numbers --format=html --template=hanna

もっと凄いドキュメント検索：sdoc

railsapiで使っているsdocというやつもある。これの検索機能がなかなかすばらしい。ただし、今のところは単体のプロジェクトでしか使えなくて、gemからtemplateとして指定することができないみたい。また、githubへのリンクもgithubを使っていないプロジェクトにとってはちょっと魅力が薄れる。にもかかわらず、とても魅力的だな。

   1  gem install voloko-sdoc --source http://gems.github.com

   1  gem install rdoc -v 2.4

   1  cd <project>
   2  sdoc -N .

参考

• mislav's hanna on github
• Offline Gem Server Rdocs
• Labnotes> Buildr: how we generate the documentation, Web site and PDF
• voloko's sdoc on github