レールアプリケーションのRdocを作成する

Question

私のレール（2.3.8）プロジェクトにドキュメントを生成したいと思います。私は

rake doc:rails 
rake doc:rerails 

それは標準Rubyのクラスとベンダーのディレクトリ内のすべてのRubyファイルを含むすべてのクラスのドキュメントを作成してみました場合には（プラグイン等。）

私はルビークラスのRDOCのドキュメントを作成することができますどのように、次のディレクトリ内のファイルは

1. appフォルダ（すべてのモデル、コントローラとビュー）
2. configフォルダ
3. libフォルダ

Answer 1

これを私のRakefileに追加しました。

RDoc::Task.new :rdoc do |rdoc| 
    rdoc.main = "README.rdoc" 

    rdoc.rdoc_files.include("README.rdoc", "doc/*.rdoc", "app/**/*.rb", "lib/*.rb", "config/**/*.rb") 
    #change above to fit needs 

    rdoc.title = "App Documentation" 
    rdoc.options << "--all" 
end 

次に実行します。

rake rdoc 

http://rdoc.rubyforge.org/RDoc/Task.html

確かに私はより多くのレール3アプリの

チェックアウトのためのRDoc ::タスクのドキュメントを、私はこれは同じ作品だと思います。

Answer 2

rake doc:appを使用すると、アプリのドキュメントを生成できます。 Rails guidesのセクション2.4から引用

：

DOC：名前空間は、あなたの アプリ、APIドキュメント、ガイドのドキュメントを生成するためのツールを持っています。ドキュメントは、 も削除することができます。これは、 のように埋め込みプラットフォーム用のRailsアプリケーションを作成する場合のように、コードベースのスリミングに主に役立ちます。

rake doc：appは、ご使用のアプリケーションのドキュメントをdoc/appに生成します。 rake doc：guidesは、ドキュメント/ガイドでRailsガイドを生成します。 rake doc：rails は、doc/apiのRails用のAPIドキュメントを生成します。