IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Bring up to date and link to add_config_value().

Browse Source
This commit is contained in:
Georg Brandl
2008-11-01 14:54:51 +00:00
parent 1ed2d916cd
commit f74f8ca7a4
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/ext/ifconfig.rst
View File

@@ -12,10 +12,22 @@ This extension is quite simple, and features only one directive:
Include content of the directive only if the Python expression given as an Include content of the directive only if the Python expression given as an
argument is ``True``, evaluated in the namespace of the project's argument is ``True``, evaluated in the namespace of the project's
configuration (that is, all variables from :file:`conf.py` are available). configuration (that is, all registered variables from :file:`conf.py` are
available).
For example, one could write :: For example, one could write ::
.. ifconfig:: releaselevel in ('alpha', 'beta', 'rc') .. ifconfig:: releaselevel in ('alpha', 'beta', 'rc')
This stuff is only included in the built docs for unstable versions. This stuff is only included in the built docs for unstable versions.
To make a custom config value known to Sphinx, use
:func:`~sphinx.application.Sphinx.add_config_value` in the setup function in
:file:`conf.py`, e.g.::
def setup(app):
app.add_config_value('releaselevel', '', True)
The second argument is the default value, the third should always be ``True``
for such values (it selects if Sphinx re-reads the documents if the value
changes).