在 Sphinx+Doxygen 文档中显示文件夹结构
Show folder structure in Sphinx+Doxygen documentation
我正在尝试将我的 C++ 代码文档作为桥梁迁移到 Sphinx (and using Breathe。
在显示项目文件夹结构的 Doxygen I like having a file list page 中。此处显示的文件是可点击的,可将您带到包含实际代码的页面。
是否可以在 Sphinx 中做类似的事情?
我知道可以使用 literalinclude
指令显示实际代码。所以我需要一个为每个文件重定向到 literalinclude
的文件夹结构。原则上这可以手动完成,但我想知道是否有自动执行此操作的方法。
我发现 Sphinx+Breathe 不可能有 C++ 文件层次结构 self-generated。幸运的是,有一个名为 exhale 的附加扩展程序可以为您完成此操作。
这是你想要的吗?
如果是这样,您需要 Exhale。 Exhale 创建第一个文件的层次结构,以隐藏 Doxygen 创建的层次结构。
我按照 Quickstart Guide 中的步骤操作,甚至有一个不同的源代码和构建树,并且一切正常,包括源代码列表。呼气文档真的很好。
我看不到 Doxygen 的内容 \mainpage
,但那是另一回事了。
我正在尝试将我的 C++ 代码文档作为桥梁迁移到 Sphinx (and using Breathe。
在显示项目文件夹结构的 Doxygen I like having a file list page 中。此处显示的文件是可点击的,可将您带到包含实际代码的页面。
是否可以在 Sphinx 中做类似的事情?
我知道可以使用 literalinclude
指令显示实际代码。所以我需要一个为每个文件重定向到 literalinclude
的文件夹结构。原则上这可以手动完成,但我想知道是否有自动执行此操作的方法。
我发现 Sphinx+Breathe 不可能有 C++ 文件层次结构 self-generated。幸运的是,有一个名为 exhale 的附加扩展程序可以为您完成此操作。
这是你想要的吗?
如果是这样,您需要 Exhale。 Exhale 创建第一个文件的层次结构,以隐藏 Doxygen 创建的层次结构。
我按照 Quickstart Guide 中的步骤操作,甚至有一个不同的源代码和构建树,并且一切正常,包括源代码列表。呼气文档真的很好。
我看不到 Doxygen 的内容 \mainpage
,但那是另一回事了。