wikinotes

Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.

{{tag>dev python sphinx documentation}}


====== 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 :

<code python>
# 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
</code>

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


<file rst 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:

</file>



===== Références =====

  * [[https://stackoverflow.com/questions/34006784/how-do-i-access-a-variable-in-sphinx-conf-py-from-my-rst-file|Comment accéder à une variable de la configuration Sphinx depuis un fichier .rst (stackoverflow.com)]]

wikinotes

Outils pour utilisateurs

Outils du site

Outils de la page