Python 使用sphinx生成API文档

目录

前言：

项目层级

Python项目docstring规范

Example Google Style Python Docstrings

Example NumPy Style Python Docstrings

reStructuredText Style

设置代码docstrings风格(pycharm)

安装sphinx

创建sphinx文档项目

配置conf.py文件

编译代码为api文档

编译文档（windows）

​编辑

设置API文档主题样式

异常处理

异常1：无法生成rst文件

异常2：WARNING: autodoc: failed to import module xxx;WARNING: autodoc: failed to import module 'xxx'; the following exception was raised:No module named 'xxx'

异常3：Encoding error：'utf8' codec can't decode byte 0xc0 in position 44：invalid start byte

---

前言：

最近需要把项目生成API文档，在网上找了下发现sphinx这个框架用的比较多，研究了一下，发现还是挺赞的，只不过纸上得来终觉浅，绝知此事要躬行，别人的项目结构啥的和自己不一样，网上基本都是单目录的层级，但是实际项目往往都会有比较深的层级关系，所以还是踩了不少坑，在此结合自己的项目总结一下。

项目层级

一般情况真实项目都是会存在多种层级关系的，这是小编做的一个项目的层级结构： 

po_pattern/
├── __init__.py
├── config/
│ ├── env_const.py
├── pages/
│ ├── __init__.py
│ ├── APage.py
│ ├── BPage.py
└── testcase/
├── __init__.py
├── conftest.py
├── scenario_part1_test.py
├── scenario_part2_test.py

Ps:po上面还有一级项目目录，跟源码目录同级创建doc目录然后切换到doc目录创建文档项目
创建文档项目