ruby - 如何向 RDoc 添加页面？

Question

新手正在尝试找出将页面添加到我的 RDoc 文档的简单任务。如果我执行 rake doc:app 并查看页面，则会有一个边栏显示“Pages”，其中列出了 README_FOR_APP。我想要做的就是创建一个名为“Cheatsheet”的页面，该页面将出现在“Pages”下。如何创建文档页面并告诉 RDoc 包含新页面？

Answer 1

IMO 这有点令人费解。这是我使用的引用资料:

• http://rake.rubyforge.org/classes/Rake/RDocTask.html
• How to Rename or Move Rails's README_FOR_APP

简而言之:

从您的 rails 库目录中获取“app”任务，例如我测试使用:

~/.rvm/gems/ruby-1.9.2-p0@foo/gems/railties-3.0.9/lib/rails/tasks/documentation.rake

您需要的部分(大致)如下所示:

namespace :doc do
  def gem_path(gem_name)
    path = $LOAD_PATH.grep(/#{gem_name}[\w.-]*\/lib$/).first
    yield File.dirname(path) if path
  end

  RDocTaskWithoutDescriptions.new("app2") { |rdoc|
    rdoc.rdoc_dir = 'doc/app'
    rdoc.template = ENV['template'] if ENV['template']
    rdoc.title    = ENV['title'] || "Rails Application Documentation"
    rdoc.options << '--line-numbers' << '--inline-source'
    rdoc.options << '--charset' << 'utf-8'
    rdoc.rdoc_files.include('doc/*_FOR_APP') # Modified this line
    rdoc.rdoc_files.include('app/**/*.rb')
    rdoc.rdoc_files.include('lib/**/*.rb')
  }
end

将其放入应用程序的 lib/tasks 目录中的 .rake 文件中，例如 doc2.rake。

如果您想保留原始名称，请更新任务名称，例如，“app2”。

将 "doc/README_FOR_APP" 字符串更新为更宽的模式，或添加新文件进行处理。

创建 doc/Cheatsheet_FOR_APP，新的 rake doc:app2 任务将拾取它。