Sphinx (генератор документации)
 | |
| Разработчик(и) | Георг Брандл |
|---|---|
| Первоначальный выпуск | 21 марта 2008 г. ( 2008-03-21 ) |
| Стабильный релиз | 8.1.3 [1] / 13 октября 2024 г. ( 2024-10-13 ) |
| Репозиторий |
|
| Написано в | Питон |
| Операционная система | Кроссплатформенный |
| Тип | Генератор документации |
| Лицензия | БСД |
| Веб-сайт | www.sphinx-doc.org |
Sphinx — это генератор документации, написанный и используемый сообществом Python. Он написан на Python , а также используется в других средах.
Назначение и функция
Sphinx преобразует файлы reStructuredText в веб-сайты HTML и другие форматы, включая PDF , EPub , Texinfo и man .
reStructuredText является расширяемым, и Sphinx использует эту расширяемую природу с помощью ряда расширений — для автоматической генерации документации из исходного кода, написания математических обозначений или выделения исходного кода и т. д.
HTML-темы
Sphinx предоставляет возможность применять темы к HTML и HTML-основанным форматам. Sphinx имеет несколько встроенных тем, включая alabaster, classic, sphinxdoc и scrolls. [2] Популярные темы, которые можно установить как модули Python, включают: [3]
- Прочитайте документы [4]
- Сфинкс Бутстрап [5]
- Жрать [6]
- Докуматт [7]
История и использование
Первый публичный релиз, версия 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
Смотрите также
.svg/1280px-Free_and_open-source_software_logo_(2009).svg.png){kind=logo}
Ссылки
- ^ "Изменения в Сфинксе". Сфинкс .
- ^ "HTML Theming". Документация Sphinx . Георг Брандл и команда Sphinx . Получено 25.06.2022 .
- ^ "Темы Sphinx". Напишите документы . Получено 2022-06-25 .
- ^ "Прочитать документацию Sphinx Theme". Репозиторий кода sphinx-rtd-theme . GitHub . Получено 25.06.2022 .
- ^ "Тема Sphinx Bootstrap". Репозиторий кода sphinx_bootstrap_theme . GitHub . Получено 25.06.2022 .
- ^ "Тема Guzzle Sphinx". Репозиторий кода guzzle_sphinx_theme . GitHub . Получено 25.06.2022 .
- ^ "Documatt Sphinx Themes Collection". Documatt.com . Получено 2022-06-25 .
- ^ "Sphinx is released! » А теперь что-то совершенно питонское..." А теперь что-то совершенно питонское... . Георг Брандл. Архивировано из оригинала 2012-03-22 . Получено 2011-04-03 .
- ^ "Об этих документах — Документация Python v2.7.1". Документация Python . Python Software Foundation . Получено 2011-04-03 .
- ^ "Руководство пользователя Blender". Blender Wiki . Blender Foundation.
- ^ "Dev:2.5/Py/API/Создание справочника API - BlenderWiki!". Blender Foundation .
- ^ "Объявляем о Read The Docs". Новости Python Software Foundation . Эрик Хольшер . Получено 15.02.2015 .
- ^ "Обновление документации ядра". LWN.net . 2016-11-02.
Внешние ссылки
- Сайт проекта генератора документации Sphinx
- Ознакомьтесь с масштабным совместным хранилищем документации Docs, работающим на базе Sphinx
