安裝或設定
由於 Sphinx 在 Python 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 中定義文件結構並開始構建文件 。