Получить и установить новый шаблон RDoc - PullRequest
Новая
       33

Получить и установить новый шаблон RDoc

0 голосов
/ 16 июня 2011

Я использую Ruby on Rails 3.0.7, и я хотел бы установить и использовать новый шаблон RDoc (вместо стандартного) для документирования своего приложения.

Я бы хотел выбрать один из следующих вариантов:

Итак,

  1. Где взять один из вышеперечисленных шаблонов?
  2. Как я могу это установить?
  3. Какой код я должен поместить в файл .rake для создания документации с выбранным шаблоном?

В двух словах, я новичок в этом вопросе.

В это время в моем Gemfile я сказал следующее: 

gem "rdoc", "~> 3.6.1"

и выполните команду bundle install.

ОБНОВЛЕНИЕ I для @ dmarkow

Я установил horo gem и вставил следующий код в мой .rake файл 

  RDoc::Task.new do |rdoc|
    rdoc.title    = "My Awesome docs"
    rdoc.rdoc_dir = 'doc'

    rdoc.options << '-f' << 'horo'
    rdoc.options << '--main' << 'README'
  end

Если я запускаю команду rdoc -f horo --main README.rdoc *.rdoc lib ext, получаю это: 

file '*.rdoc' not found
file 'ext' not found
uh-oh! RDoc had a problem:

Directory doc already exists, but it looks like it isn't an RDoc directory.

Because RDoc doesn't want to risk destroying any of your existing files,
you'll need to specify a different output directory name (using the --op <dir>
option)

Если я запускаю команду rake doc:app Я получаю это: 

WARNING: Deprecated reference to top-level constant 'Task' found at: <my_application_projectfolder>/Rakefile:7:in `<top (required)>'
    Use --classic-namespace on rake command
    or 'require "rake/classic_namespace"' in Rakefile
rake aborted!
wrong number of arguments (0 for 2)

ОБНОВЛЕНИЕ II для @ dmarkow

Я удалил каталог doc:

Если я запускаю команду rdoc -f horo --main README.rdoc *.rdoc lib ext, получаю это: 

file '*.rdoc' not found
file 'ext' not found

No newer files.

Files:      0

Classes:    0 (0 undocumented)
Modules:    0 (0 undocumented)
Constants:  0 (0 undocumented)
Attributes: 0 (0 undocumented)
Methods:    0 (0 undocumented)

Total:      0 (0 undocumented)
  0.00% documented

В каталоге документации он создает файл created.rid.

Если я запускаю команду rake doc:app, я получаю то же, что и в следующем ОБНОВЛЕНИИ.

Что мне делать? Мне все еще нужно хранить gem "rdoc", "~> 3.6.1" в моем Gemfile?

Ответы [ 2 ]

1 голос
/ 13 ноября 2011

Я предпочитаю Ханну, соответственно Ханна-нуво. Ханна была в порядке, но она основана на старой версии rdoc. Hanna-nouveau базируется на оригинальной Hanna, но работает с rdoc 3 (протестировано с rdoc 3.12).

Это выглядит как Example for Hanna

Вы можете увидеть другой пример в http://gems.rubypla.net/todonotes/0.1.0/

Подробности можно найти по адресу https://github.com/rdoc/hanna-nouveau.. Readme содержит информацию об установке и использовании.

Обновление 2014

Ханна-нуво не работает с rdoc 4.

Что вы можете сделать: Установить старую версию rdoc (я использую 3.12). Нет необходимости удалять самую актуальную версию. Вы можете вызвать версию rdoc в зависимости от: 

rdoc _3.12_ -f hanna [...more options...]

При _3.12_ загружается rdoc-версия 3.12. С -f hanna используется ханна-нуво.

0 голосов
/ 16 июня 2011

Используемый в http://api.rubyonrails.org шаблон "Horo". Вы можете найти его здесь, вместе с инструкциями по его использованию (он устанавливается через гем):

https://github.com/tenderlove/horo

...