Sphinx (генератор документации) - Sphinx (documentation generator)

Не путать с КМУ Сфинкс или же Сфинкс (поисковая система).
Сфинкс
Логотип документации по Sphinx Python.png
Разработчики)Георг Брандл
изначальный выпуск21 марта 2008 г. (2008-03-21)
Стабильный выпуск
3.3.0[1] / 2 ноября 2020 г.; 21 дней назад (2020-11-02)
Предварительный выпуск
4.0.0
Репозиторий
Отредактируйте это в Викиданных
Написано вPython
Операционная системаКроссплатформенность
ТипГенератор документации
ЛицензияBSD
Интернет сайтсфинкс-док.org

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

Назначение и функции

Сфинкс конвертирует reStructuredText файлы в HTML веб-сайты и другие форматы, включая PDF, EPub, Texinfo и человек.

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

История и использование

О первом публичном выпуске, версии 0.1.61611, было объявлено 21 марта 2008 года.[2] Он был разработан и широко используется Python проект документации.[3]

С момента своего появления в 2008 году Sphinx был принят во многие другие важные проекты Python, включая Базар, SQLAlchemy, MayaVi, SageMath, SciPy, Джанго и Пилоны. Он также используется для Блендер руководство пользователя[4] и документация по API Python.[5]

В 2010 году Эрик Хольшер объявил[6] создание Прочтите документы проект как часть усилий по упрощению сопровождения документации по программному обеспечению. Read the Docs автоматизирует процесс создания и загрузки документации Sphinx после каждого совершить.

Ядро Linux

Подсистема документации ядра Linux претерпела изменения в 2016 году. Начиная с цикла 4.7, документация начала переходить на использование Sphinx.[7]

Смотрите также

Рекомендации

  1. ^ «Изменения в сфинксе». Сфинкс.
  2. ^ «Выпущен Sphinx!» А теперь что-то полностью питоническое ... » А теперь кое-что полностью Pythonic ... Георг Брандл. Архивировано из оригинал на 2012-03-22. Получено 2011-04-03.
  3. ^ «Об этих документах - документация Python v2.7.1». Документация Python. Фонд программного обеспечения Python. Получено 2011-04-03.
  4. ^ "Руководство пользователя Blender". Blender Wiki. Blender Foundation.
  5. ^ "Dev: 2.5 / Py / API / Справочник по созданию API - BlenderWiki!". Blender Foundation. Blender Foundation.
  6. ^ "Объявление о прочтении документов". Новости Python Software Foundation. Эрик Хольшер. Получено 2015-02-15.
  7. ^ «Обновление документации ядра». LWN.net. 2016-11-02.

внешняя ссылка