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中使用的默认文件？

谢谢！

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

就是这样。希望它有所帮助。

更改RDoc模板以生成Rails应用程序文档

1 个答案: