2

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 テンプレートのデフォルトの外観はあまり好きではありません。Hanna で使用されているデフォルトの CSS ファイルを上書きする独自の CSS ファイルを提供することで、CSS を編集する方法はありますか?

ありがとう！

4

1 に答える 1

3

まず、テンプレートの場所を見つけます。

⮀ 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

それでおしまい。それが役に立てば幸い。

于 2013-04-02T12:31:15.350 に答える