Outils pour utilisateurs

Outils du site


dev:python:sphinx:reutiliser-des-variables-du-fichier-conf

Sphinx : Utiliser les variables du fichier de configuration dans la documentation

Le fichier de configuration de Sphinx définit un ensemble de variables qu'il peut être pratique de pouvoir exploiter dans la documentation comme project ou release.

Pour pouvoir utiliser ces variables présentes dans le fichier de configuration de Sphinx dans les pages de documentation il faut

En bas du fichier de configuration, ajouter le code suivant :

# Rendre disponibles certaines variables pour les pages de documentation
variables_to_export = [
    "project",
    "copyright",
    "release",
]
frozen_locals = dict(locals())
rst_epilog = '\n'.join(map(lambda x: f".. |{x}| replace:: {frozen_locals[x]}", variables_to_export))
del frozen_locals

Dans les fichier sources .rst, on utilisera la syntaxe |variable| pour accéder à son contenu :

index.rst
|project| documentation
=======================
 
Add your content using ``reStructuredText`` syntax. See the
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
documentation for details.
 
 
.. toctree::
   :maxdepth: 2
   :caption: Contents:

Références

dev/python/sphinx/reutiliser-des-variables-du-fichier-conf.txt · Dernière modification : 2025/10/05 08:27 de yoann