stringtranslate.com

Сфинкс (генератор документации)

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]

Смотрите также

Рекомендации

  1. ^ «Изменения в Сфинксе». Сфинкс .
  2. ^ «Темы HTML» . Документация Сфинкса . Георг Брандл и команда Sphinx . Проверено 25 июня 2022 г.
  3. ^ "Темы Сфинкса" . Напишите документы . Проверено 25 июня 2022 г.
  4. ^ «Прочитайте тему Docs Sphinx» . Репозиторий кода sphinx-rtd-theme . Гитхаб . Проверено 25 июня 2022 г.
  5. ^ "Тема Bootstrap Sphinx" . хранилище кода sphinx_bootstrap_theme . Гитхаб . Проверено 25 июня 2022 г.
  6. ^ "Тема Guzzle Sphinx" . Репозиторий кода guzzle_sphinx_theme . Гитхаб . Проверено 25 июня 2022 г.
  7. ^ "Коллекция тем Documatt Sphinx" . Documatt.com . Проверено 25 июня 2022 г.
  8. ^ «Сфинкс выпущен!» А теперь что-то полностью питоническое...» А теперь что-то полностью питоническое.. . Георг Брандл. Архивировано из оригинала 22 марта 2012 г. Проверено 3 апреля 2011 г.
  9. ^ «Об этих документах — документация Python v2.7.1». Документация Python . Фонд программного обеспечения Python . Проверено 3 апреля 2011 г.
  10. ^ «Руководство пользователя блендера» . Блендер вики . Фонд Блендера.
  11. ^ "Dev:2.5/Py/API/Создание справочника по API - BlenderWiki!". Фонд Блендера . Фонд Блендера.
  12. ^ «Объявление о прочтении документов» . Новости Фонда программного обеспечения Python . Эрик Холшер . Проверено 15 февраля 2015 г.
  13. ^ «Обновление документации ядра». LWN.net . 02.11.2016.

Внешние ссылки