Sphinx 是否已经适合 C++ 文档？ [已关闭]

Question

我想尝试使用 C++ 编写的新项目的文档生成器。我认为我的选择是 Doxygen 或 Sphinx。由于我有一些 Python 项目想要使用 Sphinx，所以我想知道 Sphinx 是否也是 C++ 的正确选择。 Sphinx 网站声明支持 C++，但我找不到帮助我开始使用 C++ 文档的文档。

类似的问题已经在 Stackoverflow 上进行了讨论，主要答案如下：

尚未完全可用，

但请继续关注

由于讨论已经进行了

一年多了，我想知道这个结论是否仍然有效。我应该为我的 C++ 文档选择 Doxygen 而不是 Sphinx 吗？

Answer 1

Sphinx 无法自行从 C++ 源代码中提取文档。然而，还有一些扩展，最引人注目的是

Breathe，它利用 Doxygen 从 C++ 中提取文档。

开源 {fmt} 库的文档是使用 Sphinx 与 Doxygen 的真实示例：

https://fmt.dev/latest/api.html.

Answer 2

对于 C++，Doxygen 非常好； Sphinx 对 C++ 的支持是通过 Doxygen 完成的（使用

Breathe）。

您希望两种语言只有一种工具，以提高可维护性。

Doxygen 可以从 Python 代码生成文档，因此我建议您如果可能的话，对这两个源都使用 Doxygen。 这里是 Doxygen 和 Python 的教程。