Создание RDOC для локально установленных драгоценных камней

Question

Я пытаюсь внести свой вклад в драгоценный камень, которым я недавно заинтересовался - Неста. Разработчик проделал огромную работу по созданию одной из самых легких и тонких CMS, которые вы можете найти, и я хочу задокументировать это. Я прочитал код и прокомментировал несколько методов, насколько мне известно.

Однако я пытаюсь проверить это локально, позвонив по номеру gem server и увидев изменения на моем компьютере, прежде чем вывести его в оперативный режим.

Вещи, которые я пробовал:

1. Ручное редактирование.
   • Документированный файл.
   • загорелся gem server.
2. Использование инструмента gem.
   • Документированный файл.
   • Ран gem rdoc nesta --rdoc
   • Перезагрузка gem server

Все безрезультатно. Пожалуйста, помогите.
Спасибо.

Answer 1

Вы можете просмотреть созданные html-страницы, не устанавливая модифицированную версию гема на свой компьютер. Добавьте это к Rakefile от nesta:

require 'rake/rdoctask'
Rake::RDocTask.new('doc') do |i|
  i.rdoc_files = FileList['lib/**/*']
end

и введите rake doc. Затем просмотрите сгенерированный html/index.html файл.

Answer 2

Вы уверены, что установили модифицированную версию, а не оригинальную версию?

Если вы установили измененную версию, но забыли установить rdoc, см. Можете ли вы установить документацию для существующих гемов?