爲Rails應用程序創建Rdoc

Question

我想爲我的rails（2.3.8）項目生成文檔。當我試圖

rake doc:rails 
rake doc:rerails 

它創建的所有類別，包括標準的Ruby類和供應商目錄中的所有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 

退房的RDoc的任務::更多文檔http://rdoc.rubyforge.org/RDoc/Task.html

誠然，我在軌道3應用程序，但我想這樣的作品一樣。

Answer 2

您可以使用rake doc:app生成應用程序的文檔。

從2.4節引用的Rails guides：

的文檔：命名空間提供適當的工具，爲您的 應用程序，API文檔，指南生成文檔。文檔也可以被刪除 這主要用於減少代碼庫，就像你爲嵌入式平臺編寫Rails應用程序。

rake doc：app在doc/app中爲您的應用程序生成文檔。 rake文檔：指南在doc/guides中生成Rails指南。 rake文檔：rails 在doc/api中爲Rails生成API文檔。