Как добавить пользовательский нижний колонтитул в документацию Sphinx?(ReStructuredText) - PullRequest
22 голосов
/ 07 апреля 2011

Если у меня есть какая-то документация, например, Документация Galleria , как я могу настроить ее так, чтобы при запуске команды make html она добавляла собственный нижний колонтитул на каждую страницу?

Я видел, что потенциально мог бы использовать раздел латексной преамбулы в файле conf.py, если бы выводил его в формате PDF.

Спасибо!

1 Ответ

28 голосов
/ 07 апреля 2011

Вы должны расширить макет по умолчанию, предоставив 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']

Более подробную информацию о шаблонах можно найти здесь: http://sphinx.pocoo.org/templating.html

...