sphinx.ext.ifconfig
--構成に応じてコンテンツが含まれています。¶
この拡張は非常に簡単で、ただ1つの指示しかありません。
警告
この指示は文書の内容のみを制御することを目的としている。それは部分、ラベルなどを制御できない。
-
.. 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')
第2のパラメータはデフォルト値であり、第3のパラメータは常に
'env'
このような値について(値が変更された場合、Sphinxが文書を再読み取りするか否かを選択する)。