• 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30

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

hanna.jpg

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

インストール

  1. rdoc 2.3.0をインストールする。現在のhannaはまだ最新rdocの2.4.xに対応していないからご注意ください。
    shell-unix-generic>>
    sudo gem install rdoc -v 2.3
    <<--
  2. githubをgemのsourceに追加
    shell-unix-generic>>
    gem source add http://gems.github.com
    <<--
  3. インストール
    shell-unix-generic>>
    gem install mislav-hanna
    <<--
  4. インストール済みのgemのrdocをhannaにする
    shell-unix-generic>>
    hanna --gems
    <<--
  5. これからインストールするgemのrdocもhannaにするため、.gemrcに以下の一行を追加する
    yaml>>
    rdoc: --inline-source --line-numbers --format=html --template=hanna
    <<--

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

:benchmark: false
:update_sources: true
:sources:

もっと凄いドキュメント検索: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 .
<<--
で、できあがり

sdoc.jpg

参考

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

便利そうなサービスを見つけたので紹介します。

RDocul.us

ss

いつでも最新のRDoc情報を配信してくれるサービスのようです。
ドキュメントはRDocがあればだいたい事足りるので、非常に助かります。

欲を言えばインクリメンタルサーチにも対応して欲しい :-)

posted by genki genki on Tue 17 Mar 2009 at 08:59 with 0 comments

日ごろ何かとお世話になっているRDocのバージョン2.0.0がリリースされたようです。

rdoc version 2.0.0 has been released!

RDoc is an application that produces documentation for one or more Ruby source files. RDoc includes the rdoc and ri tools for generating and displaying online documentation.

posted by genki genki on Sat 12 Apr 2008 at 11:06 with 0 comments