如何向 Sphinx 文档添加自定义页脚？

Question

如果我有一些文档，例如 Galleria 的文档，我该如何设置它，以便当我运行

make html

命令时它会向每个页面添加自定义页脚？

我发现如果我将其输出为 PDF 格式，我可能会使用 conf.py 的 LaTeX 序言

部分。

Answer 1

您必须通过提供如下所示的 html 文件来扩展默认布局：

{% extends '!layout.html' %}

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

将其保存在

_templates/

 子目录中，命名为 

layout.html

，并确保告诉 

conf.py

 在哪里可以找到此目录：

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

有关模板的更多信息可以在此处找到：

https://www.sphinx-doc.org/en/master/development/templatating.html#templated