Python有一个内置工具，可以生成名为pydoc的Python项目文档，但我认为Python Sphinx是最好的。这里我们将讨论Python Sphinx的使用。
Sphinx可以自动获取代码中的（“”“”注释）并自动生成文档。首先看看最后的效果，然后首先提到你的兴趣
安装Sphinx
pip install Sphinx
写个我们需要生成文档的项目-代码
建一个测试项目code， 下面有两个Python文件test1.p y和test2.py
test1.py代码：
test2.py代码：
使用Python-Sphinx doc####
1. 选择配置
除了以下项目外，其他的我都使用了默认值：
2.配置conf.py
在source/conf.py文件中加入如下代码， 导入自己的项目路径
3. 生成rst文件
注意:-o 后面跟的是保存rst文件的路径， 你的index.rst在哪个目录，那你就指定哪个目录。然后在后面的是你的项目(代码)路径
4. 最后执行make html,生成html文件
OK！
5.现在我们用浏览器打开doc/build/html/index.html,如下：
如果你也和我一样觉得页面UI很丑，那就继续看下一步，我们安装一个theme(主题)
安装Sphinx主题
python sphinx的主体包邮很多，我最喜欢 readthedocs风格的：
这种风格的sphinx主体包叫sphinx_rtd_theme
可以下载安装，也可以命令安装。
命令安装：
pip install sphinx_rtd_theme
配置：
编辑我们的source/conf.py
导入模块：
import sphinx_rtd_theme
将 html_theme = “alabaster”改成如下，在加上html_theme_path
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
最后我们再执行一次：make html
然后再访问文档，发现里面变的好看了，是不是？