这里是一个大纲：
- 在源文件中使用文档字符串记录您的软件包。
- 使用 sphinx-quickstart 创建一个Sphinx项目。
- 运行 sphinx-apidoc 生成设置用于autodoc的.rst源。更多信息在这里。
将此命令与
-F标志一起使用还会创建一个完整的Sphinx项目。如果您的API发生了很大变化，则可能需要多次重新运行此命令。
- 使用 sphinx-build 构建文档。
笔记：
Sphinx需要带有诸如
automodule
或伪指令的.rst文件，autoclass
以便生成API文档。没有这些文件，它不会自动从Python源中提取任何内容。这与Epydoc或Doxygen等工具的工作方式不同。这里将详细说明这些差异：docutils和Sphinx之间是什么关系？运行sphinx-apidoc后，可能需要
sys.path
在conf.py中进行调整，以使autodoc查找模块。
