Sphinx (генератор документации)
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].
Общие сведения
| Sphinx | |||
|---|---|---|---|
| Тип | Генератор документации | ||
| Разработчик | Georg Brandl | ||
| Написана на | Python | ||
| Операционная система | кроссплатформенное ПО | ||
| Первый выпуск | март 21, 2008 | ||
| Последняя версия |
6.1.3 [1] (10 января 2023) |
||
| Тестовая версия | 6.2.0 | ||
| Репозиторий | github.com/sphinx-doc/sp… | ||
| |||
| Лицензия | BSD | ||
| Сайт | sphinx-doc.org | ||
См. также
Примечания
Литература
- sphinx-doc.org — официальный сайт Sphinx
- Портал readthedocs.org использует Sphinx (см. Read the Docs)
- Python Documentation (сгенерировано с помощью Sphinx)
- Руководство по генератору документации Sphinx (рус.)
| Python | ||
 |
||