ruby-on-rails - 为 Rails 应用程序创建 Rdoc

Question

我想为我的 rails (2.3.8) 项目生成一个文档。当我尝试

rake doc:rails
rake doc:rerails

它为所有类创建文档，包括标准 ruby​​ 类和供应商目录中的所有 ruby​​ 文件(插件等)

如何仅为 ruby​​ 类、以下目录中的文件创建 rdoc 文档

app 文件夹(所有模型、 Controller 和 View )

配置文件夹

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::Task 文档了解更多信息 http://rdoc.rubyforge.org/RDoc/Task.html

不可否认，我在使用 rails 3 应用程序，但我认为这也是一样的。