为 Rails 应用程序创建 Rdoc

发布于 2024-12-02 17:51:04 字数 278 浏览 2 评论 0原文

我想为我的 Rails (2.3.8) 项目生成文档。当我尝试时，

rake doc:rails
rake doc:rerails

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

我如何仅为 ruby 类创建 rdoc 文档，以下目录

应用程序文件夹中的文件（所有模型，控制器和视图）
config 文件夹
lib 文件夹

原文

I would like to generate a documentation to my rails (2.3.8) project. When I tried

rake doc:rails
rake doc:rerails

It creates documentation for all the classes including standard ruby classes and all the ruby files in vendor directory (plugins etc..)

How can I create rdoc documentation only for ruby classes, files in following directories

app folder (all the models, controllers and views)
config folder
lib folder

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

眼藏柔 2024-12-09 17:51:04

我将其添加到我的 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 应用程序，但我认为这效果是一样的。

I added this to my 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

Then run;

rake rdoc

Check out the RDoc::Task docs for more http://rdoc.rubyforge.org/RDoc/Task.html

Admittedly I am on a rails 3 app, but I think this works the same.

回复收藏 0 原文

憧憬巴黎街头的黎明 2024-12-09 17:51:04

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

引用 Rails 指南的第 2.4 节：

doc: 命名空间具有为您的文档生成文档的工具
应用程序、API 文档、指南。文档也可以被剥离
这主要对于精简你的代码库很有用，就像你
为嵌入式平台编写 Rails 应用程序。
rake doc:app 在 doc/app 中为您的应用程序生成文档。
rake doc:guides 在 doc/guides 中生成 Rails 指南。耙子文档：rails
在 doc/api 中生成 Rails 的 API 文档。