`sphinx.ext.ifconfig` – 基于配置包含内容¶

此扩展非常简单，只提供一个指令。

警告

此指令旨在仅控制文档的内容。它无法控制节、标签等。

.. ifconfig::¶

仅当作为参数给出的 Python 表达式在项目的配置命名空间中求值为 True 时才包含指令的内容（即，conf.py 中注册的所有变量都可用）。

例如，可以编写

.. ifconfig:: releaselevel in ('alpha', 'beta', 'rc')

   This stuff is only included in the built docs for unstable versions.

要使自定义配置值在 Sphinx 中可用，请在 conf.py 中的设置函数中使用 add_config_value()，例如

def setup(app):
    app.add_config_value('releaselevel', '', 'env')

第二个参数是默认值，第三个参数应始终为 'env'，用于此类值（它选择是否在值更改时 Sphinx 重新读取文档）。

sphinx.ext.ifconfig – 基于配置包含内容¶