安裝 Sphinx¶
Sphinx 是一個 Python 應用程式。它可以使用以下描述的其中一種方式安裝。
安裝完成後，您可以執行以下命令來檢查 Sphinx 是否可用
$ sphinx-build --version
這應該會印出 Sphinx 的版本號碼。
PyPI 套件¶
Sphinx 套件發布在 Python Package Index (PyPI) 上。從 PyPI 安裝套件的首選工具是 pip，它包含在所有現代版本的 Python 中。
執行以下命令
$ pip install -U sphinx
提示
為了避免在重建環境時出現問題，建議在 requirements.txt 檔案 中釘選 sphinx 和第三方擴充套件的版本
$ pip install -r requirements.txt
或者，如果為 Python 套件編寫文件，請將相依性放置在 pyproject.toml 檔案 中
$ pip install .[docs]
Conda 套件¶
若要使用 conda，您需要一個基於 conda 的 Python 發行版，例如 anaconda、miniconda、miniforge 或 micromamba。
Sphinx 可透過 anaconda main 頻道（由 Anaconda Inc. 維護）取得
$ conda install sphinx
以及透過 conda-forge 社群頻道取得
$ conda install -c conda-forge sphinx
特定作業系統的套件管理器¶
您可以使用特定作業系統的套件管理器將全域版本的 Sphinx 安裝到您的系統中。但是，請注意，這樣做的彈性較低，如果您想要跨不同專案工作，可能會遇到相容性問題。
Linux¶
Debian/Ubuntu¶
使用 apt-get 安裝 python3-sphinx
$ apt-get install python3-sphinx
如果 Python 尚未安裝，這將為您安裝 Python。
RHEL, CentOS¶
使用 yum 安裝 python-sphinx
$ yum install python-sphinx
如果 Python 尚未安裝，這將為您安裝 Python。
其他發行版¶
大多數 Linux 發行版在其套件儲存庫中都有 Sphinx。通常套件名稱為 python3-sphinx、python-sphinx 或 sphinx。請注意，至少還有另外兩個套件的名稱中包含 sphinx：語音辨識工具組（CMU Sphinx）和全文檢索資料庫（Sphinx search）。
macOS¶
可以使用 Homebrew、MacPorts 安裝 Sphinx。
Homebrew¶
$ brew install sphinx-doc
如需更多資訊，請參閱套件概述。
MacPorts¶
使用 port 安裝 python3x-sphinx
$ sudo port install py313-sphinx
若要設定可執行路徑，請使用 port select 命令
$ sudo port select --set python python313
$ sudo port select --set sphinx py313-sphinx
如需更多資訊，請參閱套件概述。
Windows¶
可以使用 Chocolatey 安裝 Sphinx。
Chocolatey¶
$ choco install sphinx
您需要先安裝 Chocolatey 才能執行此操作。
如需更多資訊，請參閱chocolatey 頁面。
Docker¶
Sphinx 的 Docker 映像檔發布在 Docker Hub 上。有兩種映像檔
前者用於 Sphinx 的標準用法，後者主要用於使用 LaTeX 建立 PDF。請根據您的目的選擇其中一個。
注意
sphinxdoc/sphinx-latexpdf 包含 TeXLive 套件。因此，映像檔非常大（超過 2GB！）。
提示
使用 docker 映像檔時，請使用 docker run 命令來調用 sphinx 命令。例如，您可以使用以下命令來建立 Sphinx 專案
$ docker run -it --rm -v /path/to/document:/docs sphinxdoc/sphinx sphinx-quickstart
您可以使用以下命令來建立 HTML 文件
$ docker run --rm -v /path/to/document:/docs sphinxdoc/sphinx make html
如需更多詳細資訊，請閱讀 docker 映像檔的 README 檔案。
安裝最新的開發版本¶
您可以使用 --pre 標誌從 PyPI 安裝最新的開發版本
$ pip install -U --pre sphinx
警告
您通常不需要（或想要）執行此操作，但如果您在最新的穩定版本中發現可能的錯誤，這可能會很有用。
從原始碼安裝¶
您可以直接從 Git 儲存庫 的副本安裝 Sphinx。這可以透過複製儲存庫並從本機副本安裝來完成，也可以簡單地透過 git 直接安裝。
$ git clone https://github.com/sphinx-doc/sphinx
$ cd sphinx
$ pip install .
$ pip install git+https://github.com/sphinx-doc/sphinx
您也可以下載 Git 儲存庫的快照，格式為 tar.gz 或 zip。下載並解壓縮後，可以使用上述的 pip 安裝這些檔案。