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

Материал из Википедии — свободной энциклопедии
Перейти к навигации Перейти к поиску
Не следует путать с поисковой машиной Sphinx.
Sphinx
Тип Генератор документации
Разработчик Georg Brandl
Написана на Python
Операционная система кроссплатформенное ПО
Первый выпуск март 21, 2008 (2008-03-21)
Последняя версия

6.1.3

[1] (10 января 2023; 8 месяцев назад (2023-01-10))
Тестовая версия 6.2.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.[5] Он автоматизирует процесс создания и загрузки Sphinx-документации после каждой фиксации изменений в исходном коде. Проект спонсируется Python Software Foundation.[6]

См. также[править | править код]

Ссылки[править | править код]

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

Литература[править | править код]

Источник — https://ru.wikipedia.org/w/index.php?title=Sphinx_(генератор_документации)&oldid=129895340