安装或设置

由于 SphinxPython Package Index 上可用,因此可以使用 pip 进行安装 :

pip install Sphinx

或者你也可以使用 easy_install 进行安装

easy_install -U sphinx

然后,你可以通过执行以下命令来检查它是否已正确安装:

> sphinx-quickstart --version
Sphinx v1.4.1

在继续之前,你需要遵循 python PEP 8 的某些代码样式。如果你已遵循 PEP 8指南,则可以在 sphinx 中定义文档结构并开始构建文档