`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知道自定义配置值，请使用 add_config_value() 在中的设置函数中 conf.py ，例如：

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

第二个参数为缺省值，第三个参数应始终为 'env' 对于这样的值(如果值发生更改，它将选择Sphinx是否重新读取文档)。

sphinx.ext.ifconfig --根据配置包括内容¶