Рубиновый эквивалент генератора документации Sphinx?

Question

В Ruby есть несколько хороших генераторов документов, таких как Yard, rDoc, даже Glyph.Дело в том, что Sphinx делает сайты, PDF, epub, LaTex ... и т. Д.Он делает все это в реструктурированном тексте.

Есть ли альтернатива этому в мире Ruby?Может быть, комбинация программ?Если бы я мог использовать Markdown, это было бы еще лучше.

Answer 1

Начиная с версии 1.0, Sphinx имеет концепцию «доменов», которые представляют собой способы маркировки сущностей кода (таких как вызовы методов, объекты, функции и т. Д.) Из языков, отличных от Python и / или C.

Существует ruby ​​домен , так что вы можете просто использовать Sphinx.Единственное, чего вам не хватает (я думаю), это способность Sphinx автоматически создавать документацию из исходного кода, используя расширение autodoc , которое работает конкретно с кодом Python.

Answer 2

Если вы хотите использовать Markdown, вы можете проверить JDoc , который является очень простой структурой документации на основе Ruby, которая позволяет вам использовать широко поддерживаемую разметку и поставить ее под контроль исходного кода.Он позволяет редактировать документацию в любом текстовом редакторе и поддерживает:

• Markdown или Textile
• подсветка синтаксиса
• простые внутренние ссылки
• иерархическая структура документации (полезна для больших проектов)
• настраиваемые стили и структура (но она также выглядит красиво из коробки)

Он генерирует статический HTML, поэтомуПолученная документация легко размещается и не оказывает большого влияния на нагрузку на ваш сервер.

Чтобы увидеть ее в действии, посмотрите wpmvc.org .

Answer 3

Другая пара вариантов - использовать Middleman, который является генератором статического сайта, который принимает либо Kramdown, либо Markdown в качестве входных данных.

Существуют также фреймворки, разработанные специально для технической документации, в которой используется Middleman (оба из которых находятся на GitHub), включая lord / slate и pnerger / dpslate (последний является ответвлением первого и предоставляет некоторые улучшения, которые были неуместны для вытягивания). Формат Slate обеспечивает формат для документации, который включает в себя многие функции Sphinx с некоторыми дополнительными улучшениями. Он имеет трехпанельное представление документа, которое включает в себя автоматически сгенерированное оглавление, основное центральное тело, а затем образец кода панели справа. Как и в Sphinx, пример кода имеет подсветку синтаксиса.