Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/cmake/2.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
记录CMake模块的正确方式是什么?_Cmake_Documentation_Cmake Modules - Fatal编程技术网

记录CMake模块的正确方式是什么?

记录CMake模块的正确方式是什么?,cmake,documentation,cmake-modules,Cmake,Documentation,Cmake Modules,一个快速的谷歌搜索(…实际上是许多相当广泛的谷歌搜索)无法解释如何正确记录CMake模块 我要寻找的是一种记录定制CMake模块的方法,以便它们能够使用CMake--help模块命令。有什么标准的方法可以做到这一点吗?谁能给我举几个好例子吗?文档编制过程似乎很奇怪。。。。没有很好的记录。哈哈 使用cmake--help模块的模块是如何记录的 感谢您的帮助。引用我从Brad King(CMake开发者电子邮件列表成员)收到的电子邮件回复: 没有办法做到这一点。唯一的原因——帮助模块存在 这完全是因

一个快速的谷歌搜索(…实际上是许多相当广泛的谷歌搜索)无法解释如何正确记录CMake模块

我要寻找的是一种记录定制CMake模块的方法,以便它们能够使用
CMake--help模块
命令。有什么标准的方法可以做到这一点吗?谁能给我举几个好例子吗?文档编制过程似乎很奇怪。。。。没有很好的记录。哈哈

使用
cmake--help模块的模块是如何记录的


感谢您的帮助。

引用我从Brad King(CMake开发者电子邮件列表成员)收到的电子邮件回复:

没有办法做到这一点。唯一的原因——帮助模块存在 这完全是因为在3.0之前,文档是由 CMake二进制本身,人们已经习惯了 可用。它仅适用于内置模块,仅适用于 遗留的原因,也许有一天会消失在手册页的青睐 和html文档

在线文档,比如 发布
/objects.inv
以支持intersphinx:

这是在一些用户的要求下完成的,所以我还没有研究如何做到这一点 这是可行的,但人们应该能够使用斯芬克斯来产生自己的想法 拥有自己的文档,并且仍然交叉引用CMake的在线文档

如果你成功了,我们欢迎MR添加文档,描述如何, 也许在

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

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

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

pip安装sphinxcontrib ModernMakedDomain

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


好消息:你可以使用狮身人面像来记录你的CMAD模块,同时使用DoXEGEN来记录C++(或其他)源代码。

我创建了一个示例项目,它演示了如何使用<代码> SPHXTUNIB Buffic CCAMENTAZEDGE 结合狮身人面像和DoXEGEN生成C++代码和CMAGE代码:

文档。

它使用sphinxcontrib ModernMakeDomain
包和CMake自身来配置sphinx
conf.py
,然后运行sphinx


该示例主要基于以下官方CMake文档:

AFAIK,您自己的模块不能通过
CMake--help模块显示,只能通过CMake内置模块显示。至于文档,我将查看CMake源代码并复制如何编写重构文本文档的粗略格式。谢谢!我会查出来的!:)