Блог

Я использую Rake для создания документации RDoc для моего проекта, но я действительно ненавижу стиль «серое на сером», который, похоже, генерирует Darkfish. Я доволен всем остальным, я просто хотел бы сделать цветовую схему немного более читаемой.

Вот моя задача rake:

 Rake::RDocTask.new do |rd|
    rd.main = "README.rdoc"
    rd.title = "My Title"
    rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
    rd.options = ['--main', 'README.rdoc']
end
  

Я пытался добавить '--style', 'doc/rdoc.css' к rd.options приведенному выше, но он жалуется, что --style это неизвестный параметр, и игнорирует его. Кажется, я не могу найти никакой документации о том, как настраивать шаблоны или css и т.д.; должен ли я просто мириться с тем, что, по мнению Darkfish, выглядит хорошо?

Если вы посмотрите на шаблоны Darkfish, то увидите только ссылки на CSS, подобные этому:

 <link type="text/css" media="screen" href="<%= rel_prefix %>/rdoc.css" rel="stylesheet" />
  

Некоторые из них имеют rel_prefix , а некоторые нет. Ни в одном из шаблонов нет ничего для включения других таблиц стилей. Предположительно, вам следует просто применить свои изменения цвета к rdoc.css или отредактировать шаблоны вручную, чтобы включить другую таблицу стилей с вашими изменениями.

Лучшим подходом было бы исправить --style поддержку в Darkfish и отправить автору исправление. Похоже, вам просто нужно добавить немного дополнительной erb в шаблоны, немного переключить логику синтаксического анализа и новую переменную вокруг вызовов self.render_template in lib/rdoc/generator/darkfish.rb . Похоже, это было бы полезным дополнением к Darkfish, автору может быть даже приятно, что кто-то хочет улучшить его программное обеспечение.

Не могли бы вы просто взять копию css-файла, который генерирует darkfish, затем внести свои изменения и сохранить его в отдельном каталоге на вашем жестком диске. Затем в вашей задаче rake просто перезапишите файл .css, когда rdoc будет завершен?

Darkfish поддерживает шаблоны с помощью —template ‘your_template_name’; который, я полагаю, нужно будет настроить как драгоценный камень плагина rdoc.

Это также может помочь: http://fossplanet.com/f14/making-rdoc-template-gem-26986

Драгоценный камень плагина RDoc, означающий драгоценный камень со структурой каталогов, подобной:

./lib/rdoc/generator/template/#{your template name and files copied from rdoc-2.blah/lib/rdoc/generator/template/darkfish}

и

./rdoc/generate.rb добавляя к указанному выше каталогу шаблонов значение $LOAD_PATH. ( $LOAD_PATH.unshift(File.expand_path(File.join(Dir.pwd,'..','lib', "#{..... and so on}" )