为 Rails 应用程序创建 Rdoc答案

【问题标题】：creating Rdoc for a rails app为 Rails 应用程序创建 Rdoc
【发布时间】：2015-09-24 19:46:29
【问题描述】：

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

rake doc:rails
rake doc:rerails

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

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

app 文件夹（所有模型、控制器和视图）
配置文件夹
lib 文件夹

【问题讨论】：

标签： ruby-on-rails rdoc

【解决方案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 应用程序，但我认为这同样适用。

【讨论】：

这对我不起作用（对于一个 7 岁以上的答案来说并不奇怪！）但 this other answer 起作用了。

【解决方案2】：

您可以使用rake doc:app 为应用生成文档。

引用Rails guides的第2.4节：

doc: 命名空间具有为您的文档生成文档的工具应用程序、API 文档、指南。文档也可以被剥离这主要用于精简您的代码库，例如，如果您是为嵌入式平台编写 Rails 应用程序。

rake doc:app 在 doc/app 中为您的应用程序生成文档。 rake doc:guides 在 doc/guides 中生成 Rails 指南。耙文档：导轨在 doc/api 中为 Rails 生成 API 文档。

【讨论】：

当我尝试这个命令时它没有任何效果。引用的部分似乎也已从链接页面中删除。
看起来this answer 是今天的作品。