Python docutils 和 Sphinx 之间的关系

docutils 是事实上 Python 的文档生成工具。

Sphinx 是基于docutils 开发的,但是功能更加强大,有效的避免了 docutils 的问题。目前来说 Python 的文档基本上都是基于 Sphinx 进行编译的发布的。

例如我们的示例程序:

在 docs 文件夹中有个 make.bat 文件。

当你将项目克隆到本地后,运行命令:

make.bat html

运行后,将会在你的本地中创建一个 _build 文件夹。

然后你再创建的文件夹中,双击 index.html 文件。

你将会看到创建的文档。

这个创建文档的效果要比 docutils 更好