Question

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

Answer 1

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

Nutshell版本：

从rails library目录中获取“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任务将启动它。

如何将页面添加到RDoc？

1 个答案: