RDoc 标题集在 Rails 应用程序的哪个位置？

Question

rake doc:app 为 Rails 应用程序生成的文档的默认标题为“Rails 应用程序文档”。耙子设置为：

rdoc.title    = ENV['title'] || "Rails Application Documentation"

我可以通过

来改变这个

$ title='some other title' rake doc:app

但是，我想将其设置为 application.rb 或 environment'rb，但这似乎不起作用。

在 Rails 应用程序中，我应该在哪里设置 RDoc 的标题？

Answer 1

您可以这样创建 Rakefile：

RDoc::Task.new :rdoc do |rdoc|
  rdoc.main = "README.rdoc"

  #change this to fit your needs
  rdoc.rdoc_files.include("README.rdoc", "doc/*.rdoc", "app/**/*.rb", "lib/*.rb", "config/**/*.rb")

  #set your title
  rdoc.title = "App Documentation"
  rdoc.options << "--all" 
end

然后，只是：

rake rdoc

详情见RDoc::Task documentation。

Answer 2

根据 K M Rakibul Islam 的回答，自定义 Rake 任务是设置不同标题的一种方法。我在新的 lib/tasks/documentation.rake 文件中提供了一个：

require 'rails/tasks'
namespace :doc do
  RDocTaskWithoutDescriptions.new("mydoc") { |rdoc|
   rdoc.rdoc_dir = 'doc/app'                                                                                                   
    rdoc.template = ENV['template'] if ENV['template']
    rdoc.title    = "My Application Documentation"
    rdoc.options << '--line-numbers'
    rdoc.options << '--charset' << 'utf-8'
    rdoc.rdoc_files.include('README.rdoc')
    rdoc.rdoc_files.include('app/**/*.rb')
    rdoc.rdoc_files.include('lib/**/*.rb')
  }   
end

此任务与 built-in 任务相同，除了设置标题的行。我发现另一个答案生成到 html 目录而不是 doc/app 和运行很多其他东西。此任务由

执行

$ rake doc:mydoc

这是基于 2015 年 2 月 6 日的 original Rails code which I note was removed。这意味着更新到最新的 Rails 将打破这一点。

RDoc 标题集在 Rails 应用程序的哪个位置？

Where in a Rails application is the RDoc title set?

ruby-on-rails

rdoc