3.7. sphinx.ext.ifconfig

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.)

copyright:Copyright 2007-2016 by the Sphinx team, see AUTHORS. license:BSD, see LICENSE for details.

3.7.1. Functions

process_ifconfig_nodes(app, doctree, docname)
set_source_info(directive, node)
setup(app)

3.7.2. Classes

Directive(name, arguments, options, content, ...)	Base class for reStructuredText directives.
IfConfig(name, arguments, options, content, ...)
ifconfig([rawsource])