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

редактировать
Sphinx
Sphinx Python Documentation Logo.png
Разработчик (и) Георг Брандл
Первый выпуск21 марта, 2008 (2008-03-21)
Стабильная версия 3.3.0 / 2 ноября 2020 г.; 0 дней назад (2020-11-02)
Предварительный выпуск 4.0.0
Репозиторий Измените это в Wikidata
Написано вPython
Операционная система Кросс-платформенная
Тип Генератор документации
Лицензия BSD
Веб-сайтsphinx-doc.org

Sphinx - это генератор документации, написанный и используемый сообществом Python. Он написан на Python, а также используется в других средах.

Содержание
  • 1 Назначение и функция
  • 2 История и использование
    • 2.1 Ядро Linux
  • 3 См. Также
  • 4 Ссылки
  • 5 Внешние ссылки
Цель и функция

Sphinx конвертирует файлы reStructuredText в HTML веб-сайты и другие форматы, включая PDF, EPub, Texinfo и man.

reStructuredText является расширяемым, а Sphinx использует его расширяемость с помощью ряда расширений - для автоматического создания документации из исходного кода, написания математической нотации или выделения исходного кода и т. Д.

История и использование

Первый общедоступный выпуск, версия 0.1.61611, был объявлен 21 марта 2008 г. Он был разработан и широко используется в проекте Python для документации.

С момента своего появления в 2008 году Sphinx был принят во многие другие важные проекты Python, включая Bazaar, SQLAlchemy, MayaVi, SageMath, SciPy, Django и Pylons. Он также используется для руководства пользователя Blender и документации Python API.

В 2010 году Эрик Хольшер объявил о создании проекта Read the Docs как части усилия по упрощению сопровождения документации по программному обеспечению. Read the Docs автоматизирует процесс создания и загрузки документации Sphinx после каждой фиксации.

ядра Linux

Подсистема документации ядра Linux претерпела изменения в 2016 году. Начиная с цикла 4.7, документация начала переключаться. использовать Sphinx.

См. также
  • Портал бесплатного программного обеспечения с открытым исходным кодом
Ссылки
Внешние ссылки
Последняя правка сделана 2021-06-09 02:38:09
Содержание доступно по лицензии CC BY-SA 3.0 (если не указано иное).
Обратная связь: support@alphapedia.ru
Соглашение
О проекте