How can I add a custom footer to Sphinx documentation? (reStructuredText)

Question

If I have some documentation, like for example Galleria's documentation, how can I set it up so that when I run the make html command it will add a custom footer on to each page?

I saw that I could potentially use the latex preamble section of conf.py if I was outputting it to a pdf format.

Thanks!

Answer 1

You have to extend the default layout by providing an html file like this:

{% extends '!layout.html' %}

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

Save this in a _templates/ subdirectory as layout.html and make sure to tell conf.py where to find this directory:

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

More information on templating can be found here: https://www.sphinx-doc.org/en/master/templating.html