:模式:sphinx.ext.ifconfig–根据配置包含内容¶
此插件非常简单,仅具有一个指令:
警告
本指令仅用于控制文件的内容。它不能控制分区、标签等。
- .. ifconfig::¶
仅当作为参数给定的Python表达式为“True”,并在项目配置的命名空间中求值时才包含指令的内容(即:file:`配置文件`提供)。
例如,可以写下:
.. ifconfig:: releaselevel in ('alpha', 'beta', 'rc') This stuff is only included in the built docs for unstable versions.
要使Sphinx知道自定义配置值,请使用:func:~sphinx.application.sphinx.add_config_value`在setup函数中的文件:`conf.py,例如:
def setup(app): app.add_config_value('releaselevel', '', 'env')
第二个参数是默认值,对于这样的值,第三个参数应该始终是“env”(如果值更改,它将选择Sphinx是否重新读取文档)。