ruby関連のドキュメント

Rubyのドキュメント

公式ドキュメント
http://www.ruby-lang.org/ja/documentation/
RDoc
http://www.ruby-doc.org/

gemでインストールした外部ライブラリAPI


$ gem server
としてhttp://localhost:8808/にアクセスする。

Railsのドキュメント

railsもgemでインストールするのでgem serverで参照できるが、
rails専用のドキュメント生成ツールが用意されている。


$ rake doc:rails
railsアプリケーションルートで上のコマンドを実行すると、doc/api以下にドキュメントが生成される。
なおこのコマンドは、vendor/railsにあるライブラリを元にドキュメントを作成するようなのでここにrails関連ライブラリが無いと実行エラーになる。

$ rake rails:freeze:gems
とすればgem内の最新のrailsパッケージがvendor/railsに保存される。
同様に、

$ rake doc:app
とすると、自分が作成してるアプリケーションのドキュメントがdoc/appに作成される。

$ rake doc:plugins
とすると、プラグインごとのドキュメントがdoc/pluginsに作成される。