快速入门

对于这个快速入门，我们假设有以下先决条件：

• 在某处下载并提取了 breathe

• 已经安装了 doxygen，并且为要记录的项目生成了 doxygen 输出（XML 格式）（将 GENERATE_XML 标签设为 YES）

我们假设有以下的路径：

• 文档根路径：/home/me/docproj/

• breathe 路径：/home/me/docproj/ext/breathe/

• doxygen xml 输出：/home/me/docproj/doxyxml/

文档路径应该包含一个文件夹 source，其中包含 conf.py 文件。doxygen xml 输出文件夹应包含 index.xml 由 doxygen 生成的输出文件。

要整合 breathe 功能，需要采取以下步骤：

1. 在你的 conf.py 中添加 breathe 路径，方法是添加以下一行

   sys.path.append( "/home/me/docproj/ext/breathe/" )
   

2. 添加 breathe 作为插件，这一行可以这样写

   extensions = ['sphinx.ext.pngmath', 'sphinx.ext.todo', 'breathe' ]
   

3. 告诉 breathe 关于项目的信息

   breathe_projects = { "myproject": "/home/me/docproj/doxyxml/" }
   

4. 指定默认的项目

   breathe_default_project = "myproject"
   

一旦完成这些工作，你可以使用以下命令

.. doxygenindex::
.. doxygenfunction::
.. doxygenstruct::
.. doxygenenum::
.. doxygentypedef::
.. doxygenclass::

以包括不同结构的文档。对于这些命令中的每一条，都可以指定以下指令：

project

指定哪个项目，如 breathe_projects 配置值中定义的，应该用于该指令。这取代了默认值。

path

直接指定到有 doxygen 输出的文件夹的路径。这覆盖了 project 和 default project。