python使用sphinx快速生成项目开发文档

sphinx快速生成开发文档

1.安装
pip install sphinx

2.在项目的目录下创建docs目录
终端切换到docs目录后，使用命令sphinx-quickstart，如下图所示:

3.根据终端提示填写一系列的答案来快速构建。

完成后将看到构建成功提示和docs目录下会生成build和source目录以及make.bat和Makefile文件，如下图所示:

4.安装sphinx-autobuild(官方文档使用的是sphinx-build进行构建)，这里为了方便采用autobuild自动构建方式。

pip install sphinx-autobuild

5.运行构建命令

到此初始化开发文档就完成了

后续根据项目调整文档即可。
可参考文档：sphinx