关于 sphinx 的介绍描述
1,Sphinx是一个可以用于Python的自动文档生成工具，可以自动的把docstring转换为文档
2,sphinx支持多种输出格式包括html，latex，pdf等
# 安装 sphinx
yum install python-sphinx
pip install -U sphinx
# sphinx 自带了一个执行脚本
sphinx-quickstart
# -b 表示创建一个构建器 第一个目录是源目录(Sphinx项目的所有源文件) 第二个指的是文档存储目录 此命令相当于 make html 只不过不再是build之中生成了
sphinx-build -b html /home/admin/bulit/source/ /home/admin/bulit/test
# 生成 html 页面 在 build 目录之下
# make.bat Makefile 同级下执行 此命令
make html
source 下编写输出格式 在 .rst 文件之下编写
1, exmple.rst 定义了列表 超链接 以及 表格 书写形式
2, exmple1.rst 定义了函数 api输出格式！
3, exmple2.rst 定义了 标题类型 图片链接 json 数据输出 table表格 api-url
build 是自动生成的！
可以参考我的githup
https://github.com/shiqilouyang/sphinx_doc
