Сфинкс (генератор документации)
 | |
| Разработчик(и) | Георг Брандл |
|---|---|
| Первоначальный выпуск | 21 марта 2008 г. |
| Стабильная версия | 7.2.6 [1] / 13 сентября 2023 г |
| Репозиторий | |
| Написано в | Питон |
| Операционная система | Кросс-платформенный |
| Тип | Генератор документации |
| Лицензия | БСД |
| Веб-сайт | www |
Sphinx — генератор документации , написанный и используемый сообществом Python. Он написан на Python , а также используется в других средах.
Назначение и функция
[ редактировать ]Sphinx конвертирует reStructuredText файлы HTML в веб-сайты и другие форматы, включая PDF , EPub , Texinfo и man .
reStructuredText является расширяемым, и Sphinx использует свою расширяемую природу с помощью ряда расширений — для автоматического создания документации из исходного кода, написания математических обозначений или выделения исходного кода и т. д.
HTML-темы
[ редактировать ]Sphinx предоставляет возможность применять темы к HTML и форматам на его основе. Sphinx имеет несколько встроенных тем, включая алебастр, классику, sphinxdoc и свитки. [2] Популярные темы, которые можно установить как модули Python, включают: [3]
История и использование
[ редактировать ]О первом публичном выпуске версии 0.1.61611 было объявлено 21 марта 2008 года. [8] Он был разработан и широко используется в проекте Python для документации. [9]
С момента своего появления в 2008 году Sphinx был принят многими другими важными проектами Python, включая Bazaar , SQLAlchemy , MayaVi , SageMath , SciPy , Django и Pylons . Он также используется в Blender. руководстве пользователя [10] и документация по API Python. [11]
В 2010 году Эрик Холшер объявил [12] создание проекта Read the Docs в рамках усилий по упрощению обслуживания документации по программному обеспечению. Read the Docs автоматизирует процесс создания и загрузки документации Sphinx после каждого коммита .
Ядро Linux
[ редактировать ]Подсистема документации ядра Linux претерпела изменения в 2016 году. Начиная с цикла 4.7 документация начала переключаться на использование Sphinx. [13]
- Доклад на LCA2016: Чему я научился в качестве сопровождающего документации ядра на YouTube
- Доклад на LCA2017: Документация ядра: что у нас есть и где это происходит на YouTube
См. также
[ редактировать ]
Ссылки
[ редактировать ]- ^ «Перемены в Сфинксе» . Сфинкс .
- ^ «Тематика HTML» . Документация Сфинкса . Георг Брандл и команда Sphinx . Проверено 25 июня 2022 г.
- ^ «Темы Сфинкса» . Напишите документы . Проверено 25 июня 2022 г.
- ^ «Читайте тему Docs Sphinx» . Репозиторий кода sphinx-rtd-theme . Гитхаб . Проверено 25 июня 2022 г.
- ^ «Тема Sphinx Bootstrap» . хранилище кода sphinx_bootstrap_theme . Гитхаб . Проверено 25 июня 2022 г.
- ^ «Тема Guzzle Sphinx» . Репозиторий кода guzzle_sphinx_theme . Гитхаб . Проверено 25 июня 2022 г.
- ^ «Коллекция тем Documatt Sphinx» . Documatt.com . Проверено 25 июня 2022 г.
- ^ «Сфинкс выпущен!» А теперь о чем-то совершенно питоническом...» А теперь о чем-то совершенно питоническом.. . Георг Брандл. Архивировано из оригинала 22 марта 2012 г. Проверено 3 апреля 2011 г.
- ^ «Об этих документах — документация Python v2.7.1» . Документация Python . Фонд программного обеспечения Python . Проверено 3 апреля 2011 г.
- ^ «Руководство пользователя блендера» . Блендер вики . Фонд Блендера.
- ^ "Dev:2.5/Py/API/Генерация справочника по API - BlenderWiki!" . Фонд Блендера . Фонд Блендера.
- ^ «Объявление о прочтении документации» . Новости Фонда программного обеспечения Python . Эрик Холшер . Проверено 15 февраля 2015 г.
- ^ «Обновление документации ядра» . LWN.net . 02.11.2016.
Внешние ссылки
[ редактировать ]- Веб-сайт проекта генератора документации Sphinx
- Docs на базе Sphinx. Ознакомьтесь с масштабным хостом документации для совместной работы