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

メソッド検索のできるRDoc -- Hanna

Ruby

最近、そこかしこでJavascriptを使ってローカルで検索できるRDocを見かけるようになってきました。Ruby on Railsのように膨大な数のメソッドがあるソフトウェアのドキュメントを調べるのに検索機能は必須ですね。
そこで、検索のある RDoc を作る Hanna を使ってみました。

上の画像のように、メソッドのフレームの上部の入力欄にキーワードを入力すると、キーワードを含むメソッド名のみが表示されるようになります。

Hanna を使った Ruby on Rails ドキュメントの作り方

Hannaの使い方は http://github.com/mislav/hanna/tree/master に詳しく書かれていますが、ローカルに Ruby on Rails ドキュメントを作る場合は。

% sudo gem install hanna
% rails rails_doc
% cd rails_doc

ここで、Rakefile の一部を変更

#require 'rake/rdoctask'     <-- コメントアウト
require 'hanna/rdoctask'    <-- 追加

ドキュメント作成(かなり時間がかかります)。

% rake rails:freeze:gems
% rake doc:rails

これで rails_doc/doc/api ディレクトリーに Ruby on Rails ドキュメントのHTMLが出来ます。