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

除了设置标题的行外，此任务与内置任务相同。我发现另一个答案生成html目录而不是doc/app，并且还运行了很多其他的东西。该任务由

执行

$ rake doc:mydoc

这基于2015年2月6日我注意到的original Rails code removed。这意味着对最新Rails的更新将打破这一点。

Rails应用程序中的哪个是RDoc标题集？

2 个答案: