为rails应用程序创建Rdoc

Question

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

rake doc:rails
rake doc:rerails

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

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

1. app文件夹(所有模型,控制器和视图)
2. 配置文件夹
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 :: Task文档以获取更多信息http://rdoc.rubyforge.org/RDoc/Task.html

诚然,我在rails 3应用程序,但我认为这是相同的.