在Sphinx + Doxygen文档中显示文件夹结构

问题描述

我正在尝试将C ++代码文档迁移到Sphinx（并使用Breathe作为桥梁）。

在Doxygen中，我喜欢有一个file list page，其中显示了项目的文件夹结构。此处显示的文件是可单击的，并带您进入带有实际代码的页面。

是否可以在Sphinx中做类似的事情？

我知道可以通过使用literalinclude指令来显示实际代码。因此，我需要一个文件夹结构，可将每个文件重定向到literalinclude。原则上，这可以手动完成，但我想知道是否有自动的方法。

解决方法

我发现Sphinx + Breathe无法自行生成C ++文件层次结构。幸运的是，还有一个名为exhale的扩展程序可以为您完成此操作。

,

这是你想要的吗？

如果是这样，您需要 Exhale。 Exhale 创建了一个由 rst 文件构成的层次结构，其影响了 Doxygen 创建的层次结构。

我按照 Quickstart Guide 中的步骤操作，甚至使用了不同的源代码和构建树，一切都运行良好，包括源代码列表。呼气文档非常好。

我看不到 Doxygen \mainpage 的内容，但那是另一回事了。