sphinx-doc.org/en/master (URL Источник)
Пример того что получается посредством использования sphinx
Sphinx — это инструмент, упрощающий создание интеллектуальной и красивой документации, написанный Георгом Брандлом.
Первоначально он был создан для документации Python и имеет отличные возможности для документирования программных проектов на различных языках.
Следует выделить следующие особенности:
- Форматы вывода: HTML (включая Windows HTML Help), LaTeX (для версий PDF для печати), ePub, Texinfo, страницы руководства, простой текст
- Обширные перекрестные ссылки: семантическая разметка и автоматические ссылки для функций, классов, цитат, терминов глоссария и аналогичной информации
- Иерархическая структура: простое определение дерева документа с автоматическими ссылками на братьев и сестер, родителей и детей
- Автоматические индексы: общий индекс, а также индексы модуля для конкретного языка
- Обработка Код: автоматическая подсветка с использованием Pygments фломастер
- Расширения: автоматическое тестирование фрагментов кода, включение строк документации из модулей Python (документы API) и т. Д.
- Добавленные расширения: десятки расширений, добавленных пользователями ; большинство из них устанавливаются из PyPI
Sphinx использует reStructuredText в качестве языка разметки, и многие из его сильных сторон проистекают из мощности и простоты reStructuredText и его пакета для синтаксического анализа и перевода Docutils.