当写完程序，加上了 Docstring 后，可以将 Docstring 生成在线HTML文档，以直接访问网页方式了解项目功能情况。
sphinx 命令工具可以很方便地将代码中的解释直接生成网页。
其具体操作如下：
安装 sphinx
1 | pip install -U sphinx |
如果安不上，用以下命令试试
1 | easy_install -U sphinx |
安装完成后就可以在当前项目中使用 sphinx 了
具体使用步骤
这里用自建的 calc 模块为例
- 新建 docs 文件夹
在当前项目下新建 docs 文件夹，用于存放生成的文档
依次输入以下两条命令cd docs
sphinx-quickstart
执行完毕后项目中自动新增这些：
- 打开 conf.py 做如下配置修改
将路径位置更改为：
将扩展添加如下
接着打开 index.rst 添加 calc 模块,注意这里的模块就是你自己的 python 文件，不写扩展名
以上均配置完毕后就可以用 make html 命令来生成 HTML 文档文件了：
1 | make html |
由于之前在 index.rst 文件中设置的是 randoms 模块，因此创建失败，提示模块 randoms 没有找到 No module named ‘randoms’
要在 index.rst 中把 randoms 改为 calc
还是提示找不到 calc 模块的信息
这也许是由于路径描述的错误，在 conf.py 中修改路径位置为
以上完事之后再次make html
build 目录的状态,成功生成 html 文档
自动创建了许多HTML文件，直接打开 index.html 就可以查看 Docstring 了
