现代cmake的sphinx域
sphinxcontrib-moderncmakedomain的Python项目详细描述
现代cmake的sphinx域
这是直接从Kitware Git存储库的Utilities目录中获取的。 原来的sphinxcontrib-cmakedomain在相当长的一段时间里没有被触摸过，而且 结果，它完全过时了。在中记录cmake域实体 否则项目是痛苦的。它的工作原理与Kitware完全相同， 因此，可能需要一些时间来研究他们解决这些问题的方法。
此存储库与所有CMAKE都处于同一许可证下，即 BSD-3条款许可证。
我将尽我所能使这个模块与厨房用具使用的模块保持同步 他们自己。
_ 使用此插件遇到的任何问题都必须报告给Kitware
i将{str 1}$not{em1}$尽一切努力修改模块，only打包{em1}$改进。
安装
PYPI
此域可通过PYPI访问。直接通过pip：
$ pip install sphinxcontrib-moderncmakedomain
或者，把它放在你的setup.py，pyproject.toml里面，
requirements.txt或您用来声明和管理的任何系统
你的依赖。可用版本与mair版本相同
最新的cmake版本。
吉特
此模块也可以通过pip和github直接安装
$ pip install git+https://github.com/slurps-mad-rips/moderncmakedomain.git
用法
要启用moderncmakedomain的使用，请添加
sphinxcontrib.moderncmakedomain到
conf.py文件：
extensions=[...,'sphinxcontrib.moderncmakedomain',...]
插件目前提供了一些指令和参考。这些是 记录如下。
指令
| directive | description |
|---|---|
| ^{ | For a basic variable |
| ^{ | For a function |
| ^{ | Autodoc style extractor (takes a relative filepath) |
| ^{ | For environment variables |
若要声明下面找到的任何引用，必须将它们放入
sphinx sourcedir/master doc下同名的目录。因此，
prop_tgt/MY_PERSONAL_PROPERTY.rst可以用
:prop_tgt:`MY_PERSONAL_PROPERTY`。这是目前唯一的方式
允许申报新财产。
参考文献
下面的每个引用都可以放在一个同名的目录中 文档自定义扩展由您的cmake库提供。
| ref | description |
|---|---|
| ^{ | Refer to a CMake variable |
| ^{ | Refer to a CMake command |
| ^{ | Refers to an environment variable |
| ^{ | Refers to CPack generators |
| ^{ | Refers to a build file generator |
| ^{ | Used to refer to a "manual" page (like ^{ |
| ^{ | Refers to CMake Policies |
| ^{ | Refers to CMake Modules |
| ^{ | For target properties |
| ^{ | For test properties |
| ^{ | For source file properties |
| ^{ | For global properties |
| ^{ | For directory properties |
| ^{ | For installed file properties |
| ^{ | For cache properties |
欢迎加入QQ群-->： 979659372
