使用Sphinx为Python项目生成帮助文档

本文为前一篇 一个小而全的项目的延续：一个小而全的Python项目示例_持续学习持续开发，我是雷学委！-优快云博客

安装Sphinx（文档生成工具）

pip install -U Sphinx

生成默认文档配置

sphinx-quickstart

这里选择了不分离代码跟文档。

生成文档

sphinx-build -b html . _build

因为上面没有选择把代码跟文档分开，所以sphinx扫描了所有目录而不是我们模块的代码，出现下面错误：

检查一致性... /Users/mac/python/python_sample/lib/python3.8/site-packages