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

breathe-doc/breathe

Плагин для Sphinx, который добавляет документацию API на C/C++, созданную Doxygen, в reStructuredText и документацию Sphinx.

Открыть на GitHubСайт
Звёзды
816
Форки
215
Открытые issues
220
Последний коммит
6 дней назад

Что это?

Breathe связывает Doxygen и Sphinx. Doxygen анализирует исходный код и извлекает подробную модель его классов, функций и других символов, а Sphinx создаёт качественную развёрнутую документацию. Breathe читает XML-вывод Doxygen и предоставляет его в виде директив Sphinx, поэтому страницы справочника API можно оформлять и стилизовать наряду с написанным вручную текстом в одном комплекте документации.

Плагин устанавливается из PyPI с помощью pip и требует Python 3.9+, Sphinx 7.2+ и Doxygen 1.9.2+. В документации есть примеры доступных директив, а в репозитории находятся набор тестов и скрипт для сравнения вывода документации между коммитами.

Проект поддерживает небольшая группа контрибьюторов. Его используют несколько крупных open-source проектов, включая PyTorch, NumPy и Apache Arrow, чтобы публиковать справочники API для C и C++.

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

  • 01Преобразует XML-вывод Doxygen в директивы Sphinx для C, C++ и связанных символов.
  • 02Позволяет размещать страницы справочника API рядом с написанным вручную содержимым в reStructuredText.
  • 03Устанавливается из PyPI с помощью pip.
  • 04Требует Python 3.9+, Sphinx 7.2+ и Doxygen 1.9.2+.
  • 05Включает набор тестов и скрипт для сравнения вывода документации между коммитами.

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

  • Публикация справочника API библиотеки на C или C++ рядом с руководством пользователя в Sphinx.
  • Синхронизация документации API, созданной из комментариев в исходном коде, с документацией, написанной вручную.
  • Документирование встроенного ПО или системных кодовых баз, в которых уже используется Doxygen.

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

  1. 1

    Установите Breathe из PyPI

    pip install breathe

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

  • Doxygen версии 1.9.2 или новее и Sphinx версии 7.2 или новее необходимо установить отдельно.
  • Лицензия не указана в метаданных однозначно.

В подборках

Генераторы статических сайтов и инструменты для документации

Темы

#sphinx#doxygen#documentation#c-plus-plus#api-reference#python

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

Что такое breathe?
Плагин для Sphinx, который добавляет документацию API на C/C++, созданную Doxygen, в reStructuredText и документацию Sphinx. Breathe связывает Doxygen и Sphinx. Doxygen анализирует исходный код и извлекает подробную модель его классов, функций и других символов, а Sphinx создаёт качественную развёрнутую документацию. Breathe читает XML-вывод Doxygen и предоставляет его в виде директив Sphinx, поэтому страницы справочника API можно оформлять и стилизовать наряду с написанным вручную текстом в одном комплекте документации.
breathe можно использовать бесплатно? Какая у него лицензия?
breathe распространяется с открытым исходным кодом под лицензией Other. Перед использованием в коммерческих продуктах проверьте условия лицензии.
breathe всё ещё поддерживается?
Активно поддерживается. Последний коммит в breathe — 1 нояб. 2026 г..
Для чего можно использовать breathe?
Публикация справочника API библиотеки на C или C++ рядом с руководством пользователя в Sphinx. Синхронизация документации API, созданной из комментариев в исходном коде, с документацией, написанной вручную. Документирование встроенного ПО или системных кодовых баз, в которых уже используется Doxygen.
Как установить breathe?
Установите Breathe из PyPI: pip install breathe
Где скачать breathe?
Исходный код и инструкции по установке — на GitHub: https://github.com/breathe-doc/breathe

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

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

doxygen / doxygen

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

Инструменты разработчика#documentation#code-documentation#api-docs
6,6 тыс.+4 за неделю1,4 тыс.C++GPL-2.0Активно поддерживаетсяОбновлён 3 дня назад