python - Sphinx add_config_value 不添加变量

Question

尝试根据此处的文档添加一个简单的 true/false 值:

http://sphinx-doc.org/ext/ifconfig.html

在我的 conf.py 文件中:

extensions = ['sphinx.ext.todo', 'sphinx.ext.ifconfig']

# Custom variables
def setup(app):
    app.add_config_value('responsiveenabled', True, True)

在我的 grids.rst 文件(描述如何设置引导网格的页面)中，我有这个:

.. ifconfig:: responsiveenabled

Blah blah blah.

我得到的错误是:

NameError: name 'responsiveenabled' is not defined

我是否需要在 responsiveenabled 之后添加一些内容，例如“in (...)”？我想让它与我正在编写的文档版本无关。

Answer 1

你的 conf.py 文件应该是:

extensions = ['sphinx.ext.todo', 'sphinx.ext.ifconfig']

# Custom variables
def setup(app):
    app.add_config_value('responsiveenabled', True, True)

responsiveenabled = True

我知道它应该是默认值，但我无法让它工作 没有初始化。

然后你就可以使用了

.. ifconfig:: responsiveenabled

   text included if the config variable is set

text always included