Repolode
Предложить
sphinx-doc

sphinx-doc/sphinx

Генератор документации для Python, который создает HTML, PDF, EPUB и другие форматы из исходников reStructuredText или Markdown.

Открыть на GitHubСайт
Звёзды
8,072
Форки
2,610
Открытые issues
1,453
Последний коммит
7 часов назад

Что это?

Sphinx — генератор документации, который превращает исходные файлы reStructuredText в готовую к публикации документацию. Он поддерживает вывод в HTML, PDF, обычный текст, EPUB, TeX и справочные страницы, а для разбора и преобразования документов использует Docutils.

Sphinx уделяет особое внимание перекрестным ссылкам и структуре документов. Функции, классы, термины глоссария и другие объекты можно связывать семантически, а документы образуют дерево с автоматическими ссылками между соседними страницами, родительскими и дочерними. Кроме того, Sphinx автоматически создает общие и модульные индексы.

Sphinx подсвечивает код с помощью Pygments и формирует HTML с помощью шаблонизатора Jinja 2. Экосистема расширений добавляет такие возможности, как автоматическое документирование функций, поддержка Jupyter Notebook и языковые домены для Python, C, C++, JavaScript и математики.

Ключевые возможности

  • 01Создает HTML, PDF, обычный текст, EPUB, TeX и справочные страницы
  • 02Поддерживает семантические перекрестные ссылки на функции, классы и термины глоссария
  • 03Строит деревья документов с автоматическими ссылками между связанными страницами
  • 04Автоматически создает общие и модульные индексы
  • 05Подсвечивает код с помощью Pygments и формирует HTML на основе шаблонов Jinja 2
  • 06Расширяется с помощью плагинов, в том числе для поддержки языков Python, C, C++ и JavaScript

Сценарии использования

  • Публикация справочной документации по API библиотеки на Python
  • Подготовка технических руководств с выводом в PDF и HTML из одного источника
  • Ведение многоязычной документации проекта или документации с разбивкой по версиям и перекрестными ссылками

Быстрый старт

  1. 1

    Установите Sphinx из PyPI с помощью pip

    pip install -U sphinx

Что важно знать

  • В README не указано однозначное название лицензии: в метаданных указано NOASSERTION, хотя на значке отображается BSD 2-Clause.

Темы

#documentation#restructuredtext#python#docs-generator#html#pdf#docs#documentation-tool#markdown#sphinx

Частые вопросы

Что такое sphinx?
Генератор документации для Python, который создает HTML, PDF, EPUB и другие форматы из исходников reStructuredText или Markdown. Sphinx — генератор документации, который превращает исходные файлы reStructuredText в готовую к публикации документацию. Он поддерживает вывод в HTML, PDF, обычный текст, EPUB, TeX и справочные страницы, а для разбора и преобразования документов использует Docutils.
sphinx можно использовать бесплатно? Какая у него лицензия?
sphinx распространяется с открытым исходным кодом под лицензией Other. Перед использованием в коммерческих продуктах проверьте условия лицензии.
sphinx всё ещё поддерживается?
Активно поддерживается. Последний коммит в sphinx — 22 окт. 2026 г..
Для чего можно использовать sphinx?
Публикация справочной документации по API библиотеки на Python Подготовка технических руководств с выводом в PDF и HTML из одного источника Ведение многоязычной документации проекта или документации с разбивкой по версиям и перекрестными ссылками
Как установить sphinx?
Установите Sphinx из PyPI с помощью pip: pip install -U sphinx
Где скачать sphinx?
Исходный код и инструкции по установке — на GitHub: https://github.com/sphinx-doc/sphinx

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты