使用 doxygen 在 GitLab 项目上自动生成 C++ 文档答案

【问题标题】：Automatic C++ documentation generation on GitLab project using doxygen使用 doxygen 在 GitLab 项目上自动生成 C++ 文档
【发布时间】：2020-07-23 07:53:36
【问题描述】：

我在 GitLab C++ 项目中工作，我正在尝试使用 Doxygen 自动生成代码文档。我真的不知道如何解决这个问题。

我可以以某种方式将它包含在 CMake 中，以便在每次有人构建它时在项目中更新文档吗？

或者当有人推送他的代码时让服务器生成一个文档会更好吗？

感谢您的帮助！

【问题讨论】：

欢迎来到 Stack Overflow！你试过here的建议吗？
您使用的是 gitlab 还是 github（标题和文本有差异）。问题也是您想对文档做什么，因为生成的文档是派生信息，不应该放在存储库中（可能仅用于发布）。当您在构建期间生成它并希望将其存储在存储库中时，此存储是在构建之后完成的，因此是一个新的提交，因此又是一个新的构建......
我不明白 Git 是如何参与其中的。 Doxygen 通常在每个构建基础上运行。将其放入 CMake 文件中，瞧！
我正在使用 GitLab。我想将文档包含在 wiki 中，以便人们更容易理解该项目。

标签： c++ git cmake gitlab doxygen

【解决方案1】：

考虑在 GitLab Pages 站点 (https://docs.gitlab.com/ee/user/project/pages/) 上发布生成的文档，然后您可以从您的 Wiki 链接到它以方便查找。

GitLab Wiki 存储在单独的 Git 存储库 (https://docs.gitlab.com/ee/user/project/wiki/) 中，因此我认为创建 Pages 站点比从主 Git 存储库更新 Wiki Git 存储库更简洁。

【讨论】：

【解决方案2】：

是的，我认为每当有人推送时，最好有一个单独的服务器来构建文档。如果您有 Travis-CI 帐户，则可以配置将 Doxygen 文档自动部署到 GitLab Wiki。

这里是 GitHub 的 Gist 示例的链接，但应该可以扩展到 GitLab： https://gist.github.com/vidavidorra/548ffbcdae99d752da02

【讨论】：