読者です 読者をやめる 読者になる 読者になる

satococoa's blog

Web や iOS アプリを作るエンジニアの日記です

Dash で gem のドキュメントを参照する

ruby

こんな話から、インストールした gem のドキュメントが見られる風な Docset が Dash にあったのを思い出してちょっと調べてみました。

以下の手順に沿ってちょこちょこっと設定をすると、RDoc で生成された gem のドキュメントが見られました。

設定方法

  1. Preferences… -> Downloads から "Ruby Installed Gems" というdocsetをインストール
  2. Preferences… -> Docsets に Ruby Gems という docset があるので、その一番右にあるギヤのボタンからrdocが置かれているパスを設定する。gem env gempath というコマンドで rdoc の置かれるパスがわかります。
  3. "index" ボタンを押すと Dash で使えるようになります。

gem をインストールするときには .gemrc なりオプションなりで --no-ri --no-rdoc を指定している人が多いと思います。以下のコマンドで任意の gem の rdoc を生成することが出来ます。

$ gem rdoc --rdoc bubble-wrap

結果

こんな感じです。

f:id:satococoa:20141110000917p:plain

ついでに

横道にそれますが gem に限るのでしたら yard もおすすめです。

$ gem install yard
$ yard server --gems

gem rdoc コマンドで rdoc を生成しておく必要もありません。