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

Материал из Википедии — свободной энциклопедии
Перейти к: навигация, поиск
Sphinx
Тип

Генератор документации

Разработчик

Georg Brandl

Написана на

Python

Операционная система

кроссплатформенное ПО

Первый выпуск

март 21, 2008 (2008-03-21)

Последняя версия

1.3.1[1] (2015-03-17; 499 дней тому назад)

Лицензия

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.
  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.

Литература[править | править вики-текст]