Dash で gem のドキュメントを参照する
@satococoa やっぱウェブみにいくんですね、了解です。この辺も Dash とかで見れるようにしたいな
— Naoya Itoさん (@naoya_ito) 1月 22, 2013
こんな話から、インストールした gem のドキュメントが見られる風な Docset が Dash にあったのを思い出してちょっと調べてみました。
以下の手順に沿ってちょこちょこっと設定をすると、RDoc で生成された gem のドキュメントが見られました。
設定方法
- Preferences… -> Downloads から "Ruby Installed Gems" というdocsetをインストール
- Preferences… -> Docsets に Ruby Gems という docset があるので、その一番右にあるギヤのボタンからrdocが置かれているパスを設定する。
gem env gempath
というコマンドで rdoc の置かれるパスがわかります。 - "index" ボタンを押すと Dash で使えるようになります。
gem をインストールするときには .gemrc なりオプションなりで --no-ri --no-rdoc
を指定している人が多いと思います。以下のコマンドで任意の gem の rdoc を生成することが出来ます。
$ gem rdoc --rdoc bubble-wrap
結果
こんな感じです。
ついでに
横道にそれますが gem に限るのでしたら yard
もおすすめです。
$ gem install yard
$ yard server --gems
gem rdoc
コマンドで rdoc を生成しておく必要もありません。