快速的 Google 搜索(......实际上许多相当广泛的 Google 搜索)无法解释如何正确记录 CMake 模块。
我正在寻找一种记录自定义 CMake 模块的方法,以便它们与cmake --help-module <module_name>
命令。有没有标准的方法可以做到这一点?谁能给我指出一些好的例子吗?文档过程似乎很奇怪......没有很好的文档记录。哈哈。
与之配合使用的模块如何cmake --help-module
有记录吗?
任何帮助表示赞赏。
引用我从 Brad King(CMake 开发人员电子邮件列表成员)收到的电子邮件回复:
没有办法做到这一点。 --help-module 存在的唯一原因
根本是因为在 3.0 之前,文档是由
CMake 二进制文件本身,人们已经习惯了这个选项
可用的。它仅适用于内置模块并且仅适用于
遗留原因,可能有一天会消失,取而代之的是手册页
和 html 文档。
在线文档,例如https://cmake.org/cmake/help/v3.14 https://cmake.org/cmake/help/v3.14发布一个/objects.inv
支持 Intersphinx:
http://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html http://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
这是根据一些用户的要求完成的,所以我没有研究如何
这是可行的,但是人们应该能够使用 sphinx 来生成一个
自己的文档,并且仍然交叉引用 CMake 的在线文档。
如果你能做到这一点,我们欢迎 MR 添加描述如何操作的文档,
也许在
https://gitlab.kitware.com/cmake/cmake/blob/master/Help/dev/documentation.rst https://gitlab.kitware.com/cmake/cmake/blob/master/Help/dev/documentation.rst
听起来使用 Sphinx 是正确的选择。
附加信息:
Sphinx 如何知道去解析“.cmake”文件? Sphinx 是否以特殊方式识别“cmake-module”关键字并知道如何处理它?
它来自 Sphinx 模块,您可以在 CMake 源 Utilities/Sphinx/cmake.py 中找到该模块。或者您可以使用 pip 安装此文件:
pip install sphinxcontrib-moderncmakedomain
配置 Sphinx 时,您必须在 Sphinx 的配置文件 (conf.py) 中命名要使用的扩展,并将扩展的名称 (sphinxcontrib.moderncmakedomain) 添加到扩展数组中。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)