Sphinx¶

С легкостью создавайте понятную и наглядную документацию

📝 Форматирование расширенного текста

Разрабатывайте документацию, используя reStructuredText или MyST Markdown, чтобы создать высокоструктурированные технические документы, которые включают таблицы, выделенные блоки кода, математические обозначения и многое другое.

🔗 Система перекрестных ссылок

Создавайте перекрестные ссылки внутри и между своими проектами. Доступно добавление ссылок на разделы, изображения, таблицы, цитаты, глоссарии, объекты кода и другое.

📚 Универсальные форматы документации

Создавайте документацию в форматах, предпочтительных для вашей аудитории, включая HTML, LaTeX (для PDF), ePub, Texinfo, и другие.

🎨 Расширенная поддержка тем

Широкий выбор встроенных и сторонних HTML-тем, а также возможностью настраивать или создавать новые темы помогает создавать наглядную и легкочитаемую документацию.

🔌 Полная расширяемость

Добавляйте новые функции с помощью множества встроенных и ref:сторонних <third-party-extensions> расширений, предназначенных для создания диаграмм, тестирования кода и других задач.

🛠️ Автоматическая документация API

Ручное и автоматическое создание документации API (используя docstrings) доступно для Python, C++ и других доменов, что обеспечивает актуальность документации вашего кода при минимальных усилиях.

🌍 Интернационализация (i18n)

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

🌟 Активное сообщество и поддержка

Воспользуйтесь преимуществами сообщества Sphinx - его многочисленными источниками информации, туториалами, форумами и примерами.

Используется в:

Python¶

Linux Kernel¶

Project Jupyter¶

Ниже приведена информация о том, как ориентироваться в документации Sphinx.

См. также

Полный список страниц этого сайта можно найти в Содержании.

Начало работы¶

В этих разделах рассматриваются основы начала работы с Sphinx, включая создание и разработку собственной документации с нуля.

Руководство пользователя¶

Эти разделы охватывают различные темы по практическому использованию и расширению Sphinx. Они представляют собой полное руководство по использованию Sphinx для разных целей и предполагают наличие глубоких знаний о Sphinx. Если вы новичок в Sphinx, рекомендуем начать с Начало работы.

Руководство сообщества¶

Sphinx поддерживается сообществом и приветствует вклад от каждого. Разделы ниже помогут присоединиться к сообществу Sphinx, а также внести свой вклад.

Если вы хотите внести свой вклад в проект, ознакомьтесь с этим руководством.

Сообщество

Справочное руководство¶

Справочная документация имеет более полный и программный характер; она содержит информацию, к которой можно быстро обратиться. Если вам нужна документация, основанная на примерах использования (usecase-driven), см. разделы Начало работы или Руководство пользователя.

Ссылки