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



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

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

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

谢谢你的帮助!

考虑在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回购更干净。

是的,我认为无论何时有人推送,都最好有一个单独的服务器来构建文档。如果你有Travis CI帐户,你可以配置Doxygen文档到GitLab Wiki的自动部署。

请参阅GitHub的Gist示例链接,但应可扩展到GitLab:https://gist.github.com/vidavidorra/548ffbcdae99d752da02

最新更新