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

Rails 1.2 のAPIドキュメントを開発環境に作る方法 (Rails勉強会@東京第25回、初心者セッションの補足)

Ruby

Rails 2.0 がリリースされたので、あたりまえですが http://api.rubyonrails.org/ も2.0用に変わっています。

今日の Rails勉強会@東京第25回、初心者セッションで scaffold の生成するコードの解説の際に、いつもの様に「それでは このメソッド(paginate)のドキュメントを見てみましょう」と http://api.rubyonrails.org/ をアクセスすると、なんと paginate が無い・・・・

一瞬、こまった! と思いましたが Rails2.0 のドキュメントに変わったのだ! と判り その場は切り抜けられました。


さて、まだ殆どの方は Rails 1.2 で開発されていると思います。そこで Rails 1.2 のAPIドキュメント を開発環境に作る方法ですが

% rails doc_proj     <-- 1.
% cd doc_proj     
% rake rails:freeze:gems    <-- 2.
% rake doc:rails      <-- 3.
  1. まずドキュメント作成用に Railsプロジェクトを作成し(既存のRailsプロジェクト上でもかまいません)
  2. gem でインストールされたRailsソースコードをプロジェクトの vender/rails にコピーし
  3. Railsソースから、 doc/api の下に HTML形式のRDOCを作成します。

プロジェクト/doc/api/index.html をブラウザーで表示すると 1.2 版の Rails APIドキュメントが表示されます。
(スタイルが http://api.rubyonrails.org/ とは異なりますが・・・・)