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

おまけとして、簡単なメソッド検索もできます。また、テンプレート自体はhamlで書いていて、なかなか読みやすい。「スケールできる」ことが売りらしいけど、まぁ意味不明な自慢だよね。
インストール
- rdoc 2.3.0をインストールする。現在のhannaはまだ最新rdocの2.4.xに対応していないからご注意ください。
shell-unix-generic>>
sudo gem install rdoc -v 2.3
<<-- - githubをgemのsourceに追加
shell-unix-generic>>
gem source add http://gems.github.com
<<-- - インストール
shell-unix-generic>>
gem install mislav-hanna
<<-- - インストール済みのgemのrdocをhannaにする
shell-unix-generic>>
hanna --gems
<<-- - これからインストールするgemのrdocもhannaにするため、
.gemrcに以下の一行を追加する
yaml>>
rdoc: --inline-source --line-numbers --format=html --template=hanna
<<--
ちなみに、今使っている.gemrcはこんな感じ:
yaml>>
:benchmark: false
:update_sources: true
:sources:
- http://gems.rubyforge.org/
- http://gems.github.com
:bulk_threshold: 1000
:backtrace: false
:verbose: true
rdoc: --inline-source --line-numbers --format=html --template=hanna
<<--
もっと凄いドキュメント検索:sdoc
railsapiで使っているsdocというやつもある。これの検索機能がなかなかすばらしい。ただし、今のところは単体のプロジェクトでしか使えなくて、gemからtemplateとして指定することができないみたい。また、githubへのリンクもgithubを使っていないプロジェクトにとってはちょっと魅力が薄れる。にもかかわらず、とても魅力的だな。
shell-unix-generic>>
gem install voloko-sdoc --source http://gems.github.com
<<--
rdocは2.3ではなく、2.4が必要のようです。
shell-unix-generic>>
gem install rdoc -v 2.4
<<--
適当なプロジェクトで実行:
shell-unix-generic>>
cd
sdoc -N .
<<--
で、できあがり

参考
posted by
lchin on Wed 1 Apr 2009 at 01:30 with 0 comments