30 votes

Comment puis-je ajouter un pied de page personnalisé à la documentation de Sphinx ? (reStructuredText)

Si j'ai de la documentation, comme par exemple Documentation de Galleria comment puis-je faire en sorte que lorsque j'exécute l'application make html commandera-t-il l'ajout d'un pied de page personnalisé sur chaque page ?

J'ai vu que je pouvais potentiellement utiliser le préambule du latex dans le fichier conf.py si je l'éditais au format pdf.

Merci !

36voto

UncleZeiv Points 9033

Vous devez étendre la mise en page par défaut en fournissant un fichier html comme ceci :

{% extends '!layout.html' %}

{% block footer %}
        <!-- your html code here -->
{% endblock %}

Sauvegardez ceci dans un _templates/ en tant que sous-répertoire layout.html et assurez-vous de dire conf.py où trouver ce répertoire :

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Vous trouverez plus d'informations sur les modèles ici : https://www.sphinx-doc.org/en/master/templating.html

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X