11.1. 内置主题#
Sphinx 支持通过主题更改其 HTML 输出的外观。主题是 HTML 模板、样式表和其它静态文件的集合。此外,它还有一个配置文件,用于指定从哪个主题继承、使用哪种高亮样式,以及存在哪些用于自定义主题外观和感觉的选项。
主题旨在与项目无关,因此它们可以用于不同的项目而无需更改。
使用 Sphinx 提供的主题 很简单。由于这些主题不需要安装,您只需要设置 html_theme 配置值。例如,要启用 classic 主题,请将以下内容添加到 conf.py
html_theme = "classic"
您还可以使用 html_theme_options 配置值来设置主题特定的选项。这些选项通常用于更改主题的外观和感觉。例如,要将侧边栏放在右侧,并将关系栏(页面顶部和底部的导航链接栏)设置为黑色背景,请添加以下 conf.py
html_theme_options = {
"rightsidebar": "true",
"relbarbgcolor": "black"
}