为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文档。