使用sphinx自动Python项目文档
一、sphinx简介
Sphinx能够轻易地创建智慧和优雅的文档，出自Georg Brandl之手，在BSD许可证下授权。
它能够把一组 reStructuredText 格式的文件转换成各种输出格式，而且自动地生成交叉引用，生成目录等。
也就是说，如果有一个目录，里面包含一堆reST格式的文档（可能子目录里面也同样存在reST格式的文档），
Sphinx能够生成一个漂亮的组织结构以及便于浏览和导航的HTML 文件（这些文件在其他的文件夹中）。
当然对于同样的来源文件（reST格式），它也能够生成一个能够被编译（生成）PDF版本的LaTeX格式的文件。
二、rst文件
rst(ReStructuredText) 是一种用于文本数据的文件格式，主要作为 Python 编程语言技术文档的描述语言。
其旨在为 Python 创建一组类似于 Java 的 Javadoc的功能说明文档；
Docutils 可以从从 Python 程序中提取注释和信息，并将它们格式化为各种形式的程序文档，rst就是其中的一种。
rst一般组织在python源文件的doc/docs目录下，可以通过sphinx工具将rst文件转化为html文件易于阅读。
sphinx可以通过pip进行安装，可执行文件在python安装目录下的Scripts。
安装过Anaconda的sphinx已经安装，可以直接打开Anaconda的命令行执行。
三、安装sphinx(Window)
pip install sphinx
pip install sphinx_rtd_them
四、生成文档
sphinx-build -b html docs build
# 进入源文件目录（docs的上级目录），docs是rst所在的文件夹
# build是输出html的目录
五、使用make.bat批处理文件
1、配置conf.py文件
主要修改的参数如下：
sys.path.append(os.path.relpath('..'))
# 此处采用的是相对路径，就是项目相对于doc的位置
2、执行 .\make.bat html
.\make.bat html
