Описание тега python-sphinx

Описание тега Вопросы с тегом
Sphinx - это инструмент, который упрощает создание интеллектуальной и красивой документации. Sphinx особенно подходит для документации Python, но это инструмент общего назначения, который можно использовать для документирования чего угодно.

Sphinx - это инструмент, который позволяет легко создавать интеллектуальную и красивую документацию, написанную Георгом Брандлом и лицензированную по лицензии BSD.

Первоначально он был создан для новой документации Python и имеет отличные возможности для документации проектов Python, но C/C++ также уже поддерживается, и планируется добавить специальную поддержку для других языков.

Сфинкс находится в постоянном развитии. Следующие функции присутствуют, работают нормально и их можно увидеть "в действии" в документации Python:

  • Форматы вывода: HTML (включая Windows HTML Help), LaTeX (для версий PDF для печати), ePub, Texinfo, страницы руководства, простой текст

  • Обширные перекрестные ссылки: семантическая разметка и автоматические ссылки для функций, классов, цитат, терминов глоссария и аналогичной информации

  • Иерархическая структура: простое определение дерева документа с автоматическими ссылками на братьев и сестер, родителей и детей

  • Автоматические индексы: общий индекс, а также индекс модуля

  • Обработка кода: автоматическое выделение с помощью маркера Pygments

  • Расширения: автоматическое тестирование фрагментов кода, включение строк документации из модулей Python (документы API) и многое другое.

Sphinx использует reStructuredText в качестве языка разметки, и многие из его сильных сторон проистекают из мощности и простоты reStructuredText и его пакета для синтаксического анализа и перевода Docutils.

См. Также: sphinx-apidoc autodoc restructuredtext Docutils