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

Sphinx
Sphinx
Тип	Генератор документации
Разработчик	Georg Brandl
Написана на	Python
Операционная система	кроссплатформенное ПО
Первый выпуск	март 21, 2008
Последняя версия	8.2.3 (2 марта 2025; 3 месяца назад)
Тестовая версия	8.3.0
Репозиторий	github.com/sphinx-doc/sp…
Читаемые форматы файлов:
Читаемые форматы файлов:
	reStructuredText
Лицензия	BSD
Сайт	sphinx-doc.org

Sphinx — генератор документации, который преобразует файлы в формате reStructuredText в HTML website и другие форматы (PDF, EPub и man). Он использует ряд расширений для reStructuredText (например, для автоматической генерации документации по исходному коду, создания математических формул или подсветки исходного кода). Первый публичный релиз (версия 0.1.61611) был объявлен 21 марта 2008 года.^[2] Он был разработан и широко используется для документирования языка программирования Python, а также его дополнительных модулей.^[3]

С момента своего появления в 2008 году, на Sphinx перешли крупные Python-проекты: Bazaar, SQLAlchemy, MayaVi, Sage, SciPy, Django и Pylons; также он используется для документирования Blender Python API.^[4]

Read the Docs

Для облегчения поддержки документирования программного обеспечения был создан проект Read the Docs^[англ.].^[5] Он автоматизирует процесс создания и загрузки Sphinx-документации после каждой фиксации изменений в исходном коде. Проект спонсируется Python Software Foundation.^[6]

См. также

reStructuredText

Ссылки

↑ Changelog — Sphinx documentation (неопр.). Дата обращения: 11 апреля 2025. Архивировано 5 апреля 2025 года.
↑ Sphinx is released! » And now for something completely Pythonic... (неопр.) And now for something completely Pythonic.... Georg Brandl. Дата обращения: 3 апреля 2011. Архивировано 26 января 2013 года.
↑ About these documents — Python v2.7.1 documentation (неопр.). Python documentation. Python Software Foundation. Дата обращения: 3 апреля 2011. Архивировано 26 января 2013 года.
↑ Dev:2.5/Py/API/Generating API Reference - BlenderWiki! (неопр.) Blender Wiki. Blender Foundation. Дата обращения: 6 апреля 2011. Архивировано из оригинала 26 января 2013 года.
↑ Announcing Read The Docs (неопр.). Surfing in Kansas. Eric Holscher. Дата обращения: 6 апреля 2011. Архивировано 26 января 2013 года.
↑ Python Software Foundation News: PSF Funds readthedocs.org (неопр.). Python Software Foundation News. Python Software Foundation. Дата обращения: 6 апреля 2011. Архивировано 26 января 2013 года.