lest, just lest

Заметки о web-разработке, администрировании Linux и настройке Mac OS X

Bdoc и Hanna – удобный просмотр документации RubyGems

5 комментариев

Bdoc является простой и удобной заменой для gem server. Bdoc не требует запуска сервера для просмотра документации, так как он генерирует статичный html с навигацией по установленной локально документации.

Установка Bdoc очень проста:

gem install bdoc

После установки для использования достаточно одной команды:

bdoc

В результате этого во временной директории создастся html с навигацией для документации локальных gems и запустится браузер по-умолчанию.

Также в качестве параметра можно указать директорию для сохранения результата работы:

bdoc /path/to/bdoc

Совместно с Bdoc рекомендую использовать красивую и функциональную (реализован js поиск по названиям методов) rdoc тему Hanna.

Gem Hanna доступен на Gemcutter:

gem install hanna

Чтобы использовать Hanna при просмотре документации RubyGems достаточно добавить следующую строку в .gemrc:

rdoc: --inline-source --line-numbers --format=html --template=hanna

Осталось заново сгенерировать rdoc для установленных gems (с помощью командыgem rdoc --all, для RubyGems версии 1.3.6 gem rdoc --overwrite --all) и насладится результатом:

Related posts:

  1. Hello world с помощью Ruby, Sinatra и Haml
  2. Cron и Ruby: использование Whenever
  3. Использование Sinatra внутри Rails Metal
  4. Sinatra и DataMapper: пример сервиса сокращения ссылок
  5. CKEditor в Ruby on Rails c загрузкой файлов через SWFUpload

Автор: lest

Январь 11, 2010 в 10:59

Опубликовано в ruby

Метки: , , , ,

«
»

5 Responses to 'Bdoc и Hanna – удобный просмотр документации RubyGems'

Subscribe to comments with RSS or TrackBack to 'Bdoc и Hanna – удобный просмотр документации RubyGems'.

  1. Спасибо за статью. Пара исправлений:

    • gem rdoc

    • gem rdoc --all

    • rdoc: --inline-source...

    • :rdoc: --inline-source...

    Maxim Filatov

    11 Янв 10 at 22:24

  2. Изменил в тексте на gem rdoc --all.

    А второе у меня работает только как rdoc: --inline-source..., версия RubyGems 1.3.5.

    lest

    12 Янв 10 at 08:49

  3. Спасибо, очень круто.

    А как бы это применить ещё и к документации на core-api?

    Vladimir

    2 Мар 10 at 06:20

  4. Для документации по core классам применить это похоже не получится.

    Из альтернатив, предложенных участниками ror2ru, понравился http://apidock.com/ruby.

    lest

    2 Мар 10 at 17:39

  5. [...] для него hanna. Как их поставить и настроить написано в статье lest’а. Кратко: gem install bdoc [...]

    Устанавливаем некоторые необходимые gems для ruby

    29 Мар 10 at 13:12

Leave a Reply