ruby - 如何将页面添加到 RDoc？

Question

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

Answer 1

IMO 这有点令人费解。这是我使用的参考资料：

• http://rake.rubyforge.org/classes/Rake/RDocTask.html
• 如何重命名或移动 Rails 的 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.

Update the task name if you want to keep the original, e.g., "app2".

Update the "doc/README_FOR_APP" string to a wider pattern, or add new file(s) to process.

Create doc/Cheatsheet_FOR_APP and the new rake doc:app2 task will pick it up.