Sphinx可以自动获取代码中的(''' ''' 注释)，自动生成文档,接下来我们就开始使用来进行生成文档
-
在项目根目录下运行 sphinx-quickstart doc ，示例如下 # api文档放在此目录下
2 根据提示一步步来，我只处理下以下几项，其它的都是默认回车（如果有需要可以进入conf自行修改）
> Separate source and build directories (y/n) [n]: y
> Project name: TEST
> Author name(s): X.F
> Project language [en]: zh_cn
> autodoc: automatically insert docstrings from modules (y/n) [n]: y
> viewcode: include links to the source code of documented Python objects (y/n) [n]: y
3.修改 doc/source/conf.py
import os
import sys
import django # 这个最好可以加载顶部和其他的 import 放在一起
sys.path.insert(0, os.path.abspath('../..')) #路径指到项目根目录
# 下面将 settings 加到环境变量里面，等一下启动的时候就会是用这个配置
os.environ['DJANGO_SETTINGS_MODULE'] = 'JCSSJK.settings'
# 关键，用这句加载模块和上下文
django.setup()
4、生成代码文档，到项目根目录下
sphinx-apidoc -o doc/source .
注意:-o 后面跟的是保存rst文件的路径， 你的index.rst在哪个目录，那你就指定哪个目录。然后在后面的是你的项目(代码)路径
5.执行make html
到目前来说自动生成文档已经基本完成。刚开始默认的主题可能有点难看，你可以使用sphinx_rtd_theme，先pip下载下来再去conf修改 ：
另外如果想修改rst文件的内容可以参考官方文档：http://www.pythondoc.com/sphinx/rest.html#id15
最后展示下我生成的文档， 不喜勿喷，哈哈 = =：
