Разработчик (и) | Георг Брандл |
---|---|
Первый выпуск | 21 марта, 2008 (2008-03-21) |
Стабильная версия | 3.3.0 / 2 ноября 2020 г.; 0 дней назад (2020-11-02) |
Предварительный выпуск | 4.0.0 |
Репозиторий | |
Написано в | Python |
Операционная система | Кросс-платформенная |
Тип | Генератор документации |
Лицензия | BSD |
Веб-сайт | sphinx-doc.org |
Sphinx - это генератор документации, написанный и используемый сообществом Python. Он написан на Python, а также используется в других средах.
Sphinx конвертирует файлы reStructuredText в HTML веб-сайты и другие форматы, включая PDF, EPub, Texinfo и man.
reStructuredText является расширяемым, а Sphinx использует его расширяемость с помощью ряда расширений - для автоматического создания документации из исходного кода, написания математической нотации или выделения исходного кода и т. Д.
Первый общедоступный выпуск, версия 0.1.61611, был объявлен 21 марта 2008 г. Он был разработан и широко используется в проекте Python для документации.
С момента своего появления в 2008 году Sphinx был принят во многие другие важные проекты Python, включая Bazaar, SQLAlchemy, MayaVi, SageMath, SciPy, Django и Pylons. Он также используется для руководства пользователя Blender и документации Python API.
В 2010 году Эрик Хольшер объявил о создании проекта Read the Docs как части усилия по упрощению сопровождения документации по программному обеспечению. Read the Docs автоматизирует процесс создания и загрузки документации Sphinx после каждой фиксации.
Подсистема документации ядра Linux претерпела изменения в 2016 году. Начиная с цикла 4.7, документация начала переключаться. использовать Sphinx.