创建文件目录

目录结构如下

graph LR
project --> doc
project --> src-->python源文件

初始化sphinx项目

cd doc #进入doc文件夹
sphinx-quickstart #快速启动项目

配置

> Separate source and build directories (y/n) [n]: y
> Project name: sphinx_demo
> Author name(s): yourname
> Project release []: 1.0
> Project language [en]: zh_CN 或 回车默认英文

在conf.py 指定项目路径

import os
import sys
sys.path.insert(0, os.path.abspath('../../src'))

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.napoleon',
    'sphinx.ext.doctest',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.mathjax',
]

html_theme = 'sphinx_rtd_theme' #切换主题

生成文档

进入doc目录sphinx-apidoc -o source ../src/

生成html

make html

重新生成项目

1. 删除  doc/build  下的所有文件夹
   2. 删除  doc/source下除了index.rst的所有.rst文件
   3. 在doc下执行命令sphinx-apidoc -o source ../src/ 4. 在doc下执行命令make html