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]

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

• reStructuredText

Ссылки[править | править вики-текст]

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

• sphinx-doc.org — официальный сайт Sphinx
• Проекты, использующие Sphinx (eng)
• Python Documentation (сгенерировано с помощью Sphinx)
• Руководство по генератору документации Sphinx (рус)

Это заготовка статьи о программном обеспечении. Вы можете помочь проекту, дополнив её.