代码之家 › 专栏 › 技术社区 › tjwrona1992

记录cmake模块的正确方法是什么?

cmake-modules documentation cmake

0

tjwrona1992 · 技术社区 · 6 年前

快速的google搜索(实际上是许多相当广泛的google搜索)无法解释如何正确地记录cmake模块。

我要寻找的是一种记录自定义cmake模块的方法,这样它们就可以使用 cmake --help-module <module_name> 命令。有什么标准的方法吗?有人能给我举几个好例子吗?文件编制过程似乎很奇怪……没有很好的记录。哈哈。

如何使用模块 cmake --help-module 文件化?

如有任何帮助,我们将不胜感激。

0 回复 | 直到 6 年前

1

tjwrona1992 6 年前

引用Brad King(CMAKE开发者电子邮件列表成员)的电子邮件回复:

这是不可能的。唯一的原因——帮助模块存在因为在3.0之前,文档是由 cmake二进制文件本身,人们习惯于可用。它仅适用于内置模块,且仅适用于遗产的原因,也许有一天会消失在手册页上以及HTML文档。

在线文档,比如 https://cmake.org/cmake/help/v3.14 发布一个 /objects.inv 要支持Intersphinx:

http://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html

这是应一些用户的要求完成的,所以我没有调查如何这很有效,但是你应该可以用狮身人面像来产生拥有文档并仍然交叉引用cmake的在线文档。

如果你能成功的话,我们欢迎一位先生添加一些文档来描述如何, 也许在

https://gitlab.kitware.com/cmake/cmake/blob/master/Help/dev/documentation.rst

听起来用狮身人面像是个不错的选择。

其他信息:

斯芬克斯怎么知道去解析那个“.cmake”文件?斯芬克斯是否以一种特殊的方式识别“cmake模块”关键字并知道如何处理它?

它来自sphinx模块,您可以在cmake sources utilities/sphinx/cmake.py中找到。或者可以使用pip安装此文件:

pip install sphinxcontrib-moderncmakedomain

配置sphinx时,必须命名要在sphinx的配置文件(conf.py)中使用的扩展名,并将扩展名(sphinxcontrib.moderncmakedomain)添加到扩展名数组中。