module documentation

Provides the ifconfig directive that allows to write documentation that is included depending on configuration variables.

Usage:

.. ifconfig:: releaselevel in ('alpha', 'beta', 'rc')

   This stuff is only included in the built docs for unstable versions.

The argument for ifconfig is a plain Python expression, evaluated in the namespace of the project configuration (that is, all variables from conf.py are available.)

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Class ifconfig Undocumented
Class ​If​Config Undocumented
Function process​_ifconfig​_nodes Undocumented
Function setup Undocumented
def process_ifconfig_nodes(app, doctree, docname):

Undocumented

Parameters
app:SphinxUndocumented
doctree:nodes.documentUndocumented
docname:strUndocumented
def setup(app):

Undocumented

Parameters
app:SphinxUndocumented
Returns
Dict[str, Any]Undocumented