cmake - 记录 CMakeLists.txt 和自定义或本地 .cmake 文件

Question

什么是记录我的项目的好方法 CMakeLists.txt文件和本地项目 .cmake文件？有一个两年前的问题/答案 Documenting CMake scripts我基本上是在这里再次询问。答案包含声明

Currently, CMake 3.0 is under development which will get a new documentation system based on Sphinx and reStructuredText. I guess that this will bring new ways to document your modules.

我看过 cmake developer documentation ，但这个新的文档系统似乎面向 cmake 本身的文档。我不知道如何使用它来记录我的用户定义项目 CMakeLists.txt文件或本地 .cmake文件。

我希望因为 cmake 项目内部有各种 sphinx 指令和角色，所以作为用户，我可以利用 sphinx 的这种内部用法。我希望能够在我的 CMakeLists.txt 中添加一些标记文件和本地 .cmake文件，而无需重新发明轮子。在其他项目中也有相关的努力。例如，ROS catkin 项目似乎提供了我所见过的最完整的方法，但是对于非 ROS 项目来说，这是相当重量级的不容易使用的方法。 (例如，看看他们的 extracted cmake api page 。)最简单的是 sphinx-contrib cmakedomain，但这依赖于单独的 rst 源文档，而不是带有标记注释的 autodoc 方法。

也许这是 cmake 列表的问题，但我希望有人在监视 StackOverflow。

Answer 1

尽管有引用，我认为 CMake 中与 Sphinx 相关的代码对用户没有用处。我和你有同样的经历，我项目的 CMake 与 CMake 文档中使用的 Sphinx 代码不太匹配。

只需使用普通的 Sphinx 并创建您自己的模板。