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是否重新读取文档)。