主题设置¶

简介¶

Sphinx支持设置文档的主题. 主题是HTML模板, 样式表和其他静态文件的集合.

通过conf.py中的变量html_theme设置要使用的主题.

首先, 我们来看看有哪些主题:

有些主题是Sphinx内建的, 随Sphinx一起提供, 安装Sphinx后就可以直接使用.

例如, 要使用classic主题, 将以下内容添加到conf.py:

html_theme = 'classic'

对于静态主题, 可以是目录(包含theme.conf以及其他需要的文件), 或者内容相同的zip文件.

目录或zip文件必须放在Sphinx可以找到的地方, 在conf.py中, 通过变量html_theme_path设置静态主题的路径.

例如, 如果有主题blue.zip, 可以在conf.py中做如下配置:

html_theme = 'blue'
# 目录列表，设置html theme的路径
# 可以是绝对路径或者相对conf.py的相对路径
html_theme_path = ['.']

有些主题是以安装包(系统包或者Python包)的形式分发的, 可以在安装它们后使用. 如果是在Linux系统中, 可以使用系统的包管理工具(apt/yum)安装; 也可以使用Python的包管理工具pip安装.

Example:

# installing theme package
pip3 install sphinxjp.themes.dotted

安装后在conf.py中配置要使用的主题:

html_theme = 'dotted'

常用的第三方主题可以在PyPI, GitHub 和sphinx-themes.org上查找.

参考: