Sphinx文档项目配置

12.1. Sphinx文档项目配置#

此部分内容说明使用 Sphinx 进行文档项目维护时的技术要求。

12.1.1. conf.py常用配置#

Sphinx使用 conf.py 进行配置。

templates_path = ['_templates']
source_suffix = '.rst'
master_doc = 'index'
version = '6.0'
release = '6.0'
language = 'zh_CN'
numfig = True

在使用图表自动编号时，需要使用 numfig = True 。

12.1.2. Sphinx常用主题#

在Debian仓储中可直接安装使用的主题：

  • pydata-sphinx-theme

  • sphinx-rtd-theme

  • jupyter-sphinx-theme

  • sphinx-bootstrap-theme

  • sphinx-book-theme

目录