ruby-on-rails - 更改用于生成 Rails 应用程序文档的 RDoc 模板

Question

我刚刚向我的 Rails 3.2.13 应用程序添加了一些文档。我可以使用 rake 任务很好地生成文档(运行 RDoc 3.12.2):

# lib/tasks/documentation.rake
Rake::Task["doc:app"].clear
Rake::Task["doc/app"].clear
Rake::Task["doc/app/index.html"].clear

namespace :doc do
    RDoc::Task.new('app') do |rdoc|
        rdoc.rdoc_dir  = 'doc/app'
        rdoc.generator = 'hanna'
        rdoc.title     = 'Stoffi Web App Documentation'
        rdoc.main      = 'doc/Overview'
        rdoc.options << '--charset' << 'utf-8'
        rdoc.rdoc_files.include('app/**/*.rb')
        rdoc.rdoc_files.include('doc/*')
    end
end

...然后运行rake doc:app。但我真的不喜欢 Hanna 模板的默认外观。有没有一种方法可以编辑 CSS，也许可以通过提供我自己的 CSS 文件来覆盖 Hanna 中使用的默认 CSS 文件？

谢谢!

Answer 1

首先找到您的模板所在的位置:

⮀ RDPATH=$(dirname $(gem which rdoc))
# ⇒ /home/am/.rvm/rubies/ruby-head/lib/ruby/2.1.0

现在将默认模板从那里复制到所需位置(将 /tmp 更改为您的项目目录或类似目录):

⮀ cp -r $RDPATH/rdoc/generator/template/darkfish /tmp/myniftytemplate

最后，让我们来学习一下 rdoc:

class RDoc::Options
  def template_dir_for template
    "/tmp/#{template}"
  end
end

RDoc::Task.new('app') do |rdoc|
  rdoc.template = 'myniftytemplate'
  …
end

就是这样。希望对您有所帮助。