Где найти шаблон rdoc Rails API

Я пытаюсь улучшить свою документацию по rdoc, используя версию 3.5.3. Я не фанат встроенной темы darkfish, поэтому я попытался найти способ заменить ее тем, что используется в официальной документации API Rails по адресу http://api.rubyonrails.org/, но мне не удалось найти его в какой-либо доступной форме. Я искал по всему github, между прочим.

То, что я нашел до сих пор,

который может быть немного устаревшим, и это форк

Оба хороши, но не совсем то, что я хочу. Итак, прежде чем я начну возиться с этими шаблонами, кто-нибудь знает, доступен ли где-нибудь шаблон, используемый документами Rails API, в качестве драгоценного камня?

Спасибо!


ruby templates rdoc
person Thilo    schedule 05.05.2011    source источник

Ответы (2)


arrow_upward
3
arrow_downward

Это похоже на это. Игнорируйте инструкции, в которых говорится, что нужно выполнить gem install horo --pre — это фактически даст вам более старую бета-версию. Просто выполните gem install horo, и вы получите текущую версию 1.0.3 (Изменить: я отправил запрос на обновление инструкций, который уже принят).

https://github.com/tenderlove/horo

Кстати, я нашел это, просмотрев исходный код Rails и просмотрев Rakefile, чтобы увидеть параметры RDoc. . В частности, строка 67 показывает rdoc.options << '-f' << 'horo'.

person Dylan Markow    schedule 05.05.2011
comment
Кстати, я тоже смотрел туда (railties-3.0.4), но все, что я нашел, это 'rdoc.template = ENV['template'] if ENV['template']'... это мне не помогло. Где именно вы его нашли? - person Thilo; 05.05.2011
comment
Строка 67 Rakefile (НЕ rakefile Railties, Rakefile в корне проекта) - person Dylan Markow; 05.05.2011

arrow_upward
4
arrow_downward

Я знаю, что это очень поздно, но похоже, что новая версия Rails использует что-то под названием sdoc, которое улучшает вывод с помощью поиска JavaScript и немного чище, IMO. Выполнение простого «gem install sdoc» даст вам то, что вам нужно, а затем просто используйте rdoc.options << '-f' << 'sdoc'.

Проект github находится по адресу https://github.com/voloko/sdoc/.

Кстати, спасибо за вопрос! Без опубликованного первоначального ответа я бы никогда не нашел, где искать, и застрял бы с этой ужасной темной темной темой для своих собственных проектов!

person Nerdmaster    schedule 03.09.2011