sphinx.ext.ifconfig – Inclure du contenu basé sur la configuration

Cette extension est assez simple et ne comporte qu’une seule directive :

Avertissement

Cette directive est conçue pour contrôler uniquement le contenu du document. Elle ne contrôle pas les sections, les étiquettes, etc.

.. ifconfig::

Inclure le contenu de la directive uniquement si l’expression Python donnée en argument est True, évaluée dans l’espace nom de la configuration du projet (c’est-à-dire que toutes les variables enregistrées dans :file:`conf.py” sont disponibles).

Par exemple, on pourrait écrire

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

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

Pour faire connaître une valeur de configuration personnalisée à Sphinx, utilisez add_config_value() dans la fonction Setup du fichier::`conf.py, par exemple: :

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

Le deuxième argument est la valeur par défaut, le troisième devrait toujours être 'env' pour ces valeurs (il est sélectionné si Sphinx relit les documents si la valeur change).