Как настроить таблицу стилей rdoc Darkfish? - PullRequest
Новая
       6

Как настроить таблицу стилей rdoc Darkfish?

1 голос
/ 07 апреля 2011

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

Вот мое задание по рейку: 

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 считает хорошим?

Ответы [ 3 ]

1 голос
/ 02 марта 2012

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

1 голос
/ 07 апреля 2011

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

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

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

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

0 голосов
/ 08 апреля 2011

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}")

...