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

Question

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

目前,CMake 3.0正在开发中,它将获得基于Sphinx和reStructuredText的新文档系统.我想这会带来记录模块的新方法.

我查看了cmake开发人员文档,但是这个新的文档系统似乎是针对cmake本身的文档.我不知道如何使用它来记录我的用户定义的项目CMakeLists.txt文件或本地.cmake文件.

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

也许这是cmake列表的问题,但我希望有人监控StackOverflow.

Answer 1

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

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