Файл конфигурации

Общие настройки задаются в разделе General configuration файла conf.py.

Изменение названия и копирайта

# General information about the project.
project = 'My Project'
copyright = '2017, Ivan Ivanov'

Cтроки Unicode

Использование кириллических символов в названиях проекта и других строках, может приводить к ошибкам генерации. В версии Sphinx для Python 3 таких проблем не наблюдается. В версии для Python 2.7 перед каждой кириллической строкой необходимо ставить u.

project = u'Мой проект'
copyright = u'2017, Иван Иванов'

Версии публикации

Изменить параметры version и release:

# The short X.Y version.
version = '1'
# The full version, including alpha/beta/rc tags.
release = '1'

Смена HTML-темы

В строке html_theme указать название используемой темы:

html_theme = 'sphinx_rtd_theme'

Раскомментировать строку html_theme_path и прописать в ней путь к HTML-теме:

html_theme_path = ['.']

В Sphinx есть ряд встроенных тем. Для их подключения достаточно написать название темы в строке html_theme, путь указывать не надо. Названия стандартных тем:

• default
• sphinxdoc
• scrolls
• agogo
• traditional
• nature
• haiku
• pyramid

Некоторые из перечисленных тем поддерживают дополнительные настройки. Подробнее смотрите раздел HTML theming support официальной документации Sphinx.

Примечание

В Read The Docs при значении html_theme = 'default' используется тема Read The Docs.