doxygen - 在阅读文档中使用 Doxygen

Question

我已经使用 Doxygen 和 Markdown 为中型 C++ 软件编写了文档。我对它很满意，因为在更改了 xml 层后，我最终得到了这样的结果:
http://docs.mitk.org/nightly/index.html

我想将此文档联机，最好使用 ReadtheDocs 之类的东西，其中文档将在“git commit”后自动构建，并托管以供浏览。

ReadtheDocs 看起来像理想的站点，但使用 Sphinx 和 reStructuredText 作为默认站点。 Doxygen 也可以使用，但 AFAIK 只能通过呼吸。如果我不想将所有 API 文档转储到单个页面 ( http://librelist.com/browser//breathe/2011/8/6/fwd-guidance-for-usage-breathe-with-existing-doxygen-set-up-on-a-large-project/#cab3f36b1e4bb2294e2507acad71775f ) 中，那么通过这条路线基本上意味着我需要重新构建所有文档。

矛盾的是，Doxygen 安装在 read-the-docs 服务器中，但在努力之后我找不到跳过它的 Sphinx 或 Mkdocs 的解决方法。

Answer 1

我尝试了以下解决方案来在 Read The Docs 上使用 Doxygen，它似乎有效:

设置空 sphinx 项目(请参阅官方 sphinx 文档)，

在 sphinx conf.py 添加命令来构建 doxygen 文档，

使用 conf.py html_extra_path 配置指令覆盖生成的 doxygen 文档而不是生成的 sphinx 文档。

我已经使用以下源代码树对此进行了测试:

.../doc/Doxyfile
       /build/html
       /sphinx/conf.py
       /sphinx/index.rst
       /sphinx/...

一些解释:

在我的设置中，doxygen 在“doc/build/html”中生成它的文档，

ReadTheDocs 在找到 conf.py 文件的目录中运行它的命令。

该怎么办:

在 conf.py 中添加以下行以生成 doxygen 文档:

 import subprocess
 subprocess.call('cd .. ; doxygen', shell=True)

将 conf.py html_extra_path 指令更新为:

 html_extra_path = ['../build/html']

在这个配置中 ReadTheDocs 应该正确地生成和存储 Doxygen html 文档。

去做:

其他文档格式，例如:pdf。