Sphinx +breathe HTML 输出与 doxygen HTML 输出不同

问题描述 投票:0回答:1

我需要你的帮助。

我使用 Sphinx 创建了一个文档。

在此文档中,我需要添加另一个有关 C API 的文档。该 API 有现成的 doxygen 文档(html+latex+xml 文件)

我使用了 Doxygen 生成的 XML 文件,并在 Breathe 的帮助下将它们集成到我的 Sphinx 项目中。

它有效并且两个文档已链接。

但问题是(C API 的)sphinx HTML 输出的结构不如 doxygen HTML 输出。

Doxygen html 输出将模块分组到一个页面中,将数据结构分组到另一个网页中,并且整个输出是可读的。

但是,sphinx html输出将所有信息放在一页上,用户几乎无法阅读。

注 1:Sphinx 会模仿 index.xml 文件的精确结构,无论 Doxygen 将其置于可读的结构良好的形式中。

注2:我只有一个头文件,不能使用多个目录。

我可以做什么来解决这个问题?

谢谢你

  • 我尝试更改 Doxyfile 配置中的多个元素,但没有成功。

预期结果: Sphinx HTML 输出应与 Doxygen HTML 输出具有相同的结构和页面。

python c xml python-sphinx doxygen
1个回答
0
投票

更新: 我没有仅使用指令 doxygenindex,而是对要记录的每个元素使用多个指令来解决此问题。

敌人的例子:

  • 氧组
  • doxygenstruct

链接:https://breathe.readthedocs.io/en/latest/directives.html

© www.soinside.com 2019 - 2024. All rights reserved.