sphinx_rtd_theme
1.0.0
Эта тема Sphinx была разработана, чтобы обеспечить удобство чтения пользователям документации как на настольных, так и на мобильных устройствах. Эта тема используется в основном в Read the Docs, но может работать с любым проектом Sphinx. Вы можете найти рабочую демо-версию темы в документации темы.
Эта тема распространяется на PyPI и может быть установлена с помощью pip :
$ pip установить sphinx-rtd-theme
Чтобы использовать эту тему в своем проекте Sphinx, вам необходимо отредактировать настройку html_theme вашего файла conf.py :
html_theme = "sphinx_rtd_theme"
См. также:
Поддерживаемые браузеры
Официально поддерживаемые и протестированные комбинации браузера и операционной системы.
Поддерживаемые зависимости
Поддерживаемые версии Python, Sphinx и другие зависимости.
Пример документации
Полный пример вывода этой темы с включенными локализованными строками.
Эта тема легко настраивается как на уровне страницы, так и на глобальном уровне. Чтобы увидеть все возможные варианты конфигурации, прочтите документацию по настройке темы.
Если вы хотите помочь изменить или перевести тему, вы найдете дополнительную информацию о том, как внести свой вклад, в нашем руководстве по участию.
