sphinx的简单使用

Sphinx是一个python库，能根据项目中的注释内容自动生成代码api文档，非常好用。本文主要介绍Sphinx的简单使用

遵循下面步骤即可完成sphinx的简单上手使用

1、首先安装sphinx库

 pip install sphinx 

2、然后在项目中新建docs文件夹（非必须）

3、在终端中cd到新建的docs文件夹内

4、运行初始化命令

 sphinx-quickstart 

上述命令中，终端会显示一些内容选项让你输入，除了语言写zh_cn外，其他默认回车即可

5、第四步运行完之后，就会看到在doc文件夹内生成了conf.py文件，配置该文件。主要修改的地方是：

import os
import sys

//abspath()中的地址改为项目根目录的地址
sys.path.insert(0, os.path.abspath('./../../project_path'))

...

//这三个插件要包含进去
extensions = [
    'sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc'
] 

6、配置完之后即可运行生成rst文件的命令：

sphinx-apidoc -o 第二步创建的docs文件的绝对路径 项目根目录的绝对路径 

7、最后一步，生成html文件,终端输入：

make html 

此时运行结束，docs文件夹内生成_build文件夹，里面有个html目录，该目录下会生成很多html文件，用浏览器打开index.html，即可浏览生成最终文档

至此，完全结束！