Repolode
提交项目
breathe-doc

breathe-doc/breathe

一个 Sphinx 插件，把 Doxygen 生成的 C/C++ 接口文档整合进 reStructuredText 和 Sphinx 文档中。

在 GitHub 查看官网
Star
816
Fork
215
未关闭 Issue
220
最近提交
6天前

这是什么？

Breathe 连接了 Doxygen 与 Sphinx 两者。Doxygen 负责解析源代码，提取类、函数等符号的详细结构；Sphinx 负责生成高质量的长篇文档。Breathe 读取 Doxygen 的 XML 输出，并将其以 Sphinx 指令的形式提供，使接口参考页面可以和手写的文档内容一起编写、统一风格。

项目通过 pip 从 PyPI 安装，需要 Python 3.9 以上、Sphinx 7.2 以上以及 Doxygen 1.9.2 以上版本。仓库中包含测试套件，并提供了用于比较不同提交文档输出差异的脚本。

多个大型开源项目，如 PyTorch、NumPy 和 Apache Arrow，都使用它来发布 C 和 C++ 的 API 参考文档。

核心功能

  • 01将 Doxygen 的 XML 输出渲染为 Sphinx 指令，覆盖 C、C++ 等符号。
  • 02让接口参考页面与手写的 reStructuredText 内容共存于同一文档。
  • 03可通过 pip 从 PyPI 安装。
  • 04需要 Python 3.9+、Sphinx 7.2+ 和 Doxygen 1.9.2+。
  • 05提供测试套件，以及用于比较不同提交文档输出的脚本。

适用场景

  • 在 Sphinx 中将 C 或 C++ 库的 API 参考与用户指南一起发布。
  • 让从源码注释生成的接口文档与手写文档保持同步。
  • 为已经使用 Doxygen 的嵌入式或系统级代码库编写文档。

快速上手

  1. 1

    从 PyPI 安装 Breathe

    pip install breathe

使用前须知

  • 需要另外安装 Doxygen 1.9.2 及以上版本和 Sphinx 7.2 及以上版本。
  • 元数据中的许可证信息不明确。

收录于专题

静态网站生成器与文档工具

标签

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

常见问题

breathe 是什么？
一个 Sphinx 插件，把 Doxygen 生成的 C/C++ 接口文档整合进 reStructuredText 和 Sphinx 文档中。 Breathe 连接了 Doxygen 与 Sphinx 两者。Doxygen 负责解析源代码，提取类、函数等符号的详细结构；Sphinx 负责生成高质量的长篇文档。Breathe 读取 Doxygen 的 XML 输出，并将其以 Sphinx 指令的形式提供，使接口参考页面可以和手写的文档内容一起编写、统一风格。
breathe 可以免费使用吗？用的什么许可证？
breathe 以 Other 许可证开源。用于商业产品前，请先确认许可证条款。
breathe 还在维护吗？
活跃维护中。breathe 最近一次提交是在 2026年11月1日。
breathe 适合用来做什么？
在 Sphinx 中将 C 或 C++ 库的 API 参考与用户指南一起发布。 让从源码注释生成的接口文档与手写文档保持同步。 为已经使用 Doxygen 的嵌入式或系统级代码库编写文档。
breathe 怎么安装和运行？
从 PyPI 安装 Breathe: pip install breathe
在哪里获取 breathe？
源代码和安装说明在 GitHub 上：https://github.com/breathe-doc/breathe

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目