`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 的 setup 函式中使用 add_config_value()，例如：

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

第二個引數是預設值，第三個引數對於此類值應始終為 'env'（它選擇當值變更時 Sphinx 是否重新讀取文件）。

sphinx.ext.ifconfig – 根據組態包含內容¶