安装Sphinx¶
Sphinx是一个Python应用程序。它可以通过下面描述的方式之一安装。
安装后，您可以通过运行：：检查Sphinx是否可用
$ sphinx-build --version
这应该会打印出Sphinx版本号。
PyPI包¶
Sphinx包发布在 Python Package Index （PyPI）。 从PyPI安装包的首选工具是 pip ，它包含在所有现代版本的Python中。
运行以下命令：：
$ pip install -U sphinx
小技巧
为了避免重建环境时出现问题，建议将phinx和第三方扩展版本固定在 requirements.txt file: :
$ pip install -r requirements.txt
或者，如果为Python包编写文档，请将依赖项放置在 pyproject.toml file: :
$ pip install .[docs]
Conda套件¶
使用 conda ，您需要一个基于conda的Python发行版，例如 anaconda, miniconda, miniforge or micromamba.
Sphinx可通过 anaconda main 频道（由Anaconda Inc.维护）
$ conda install sphinx
以及通过被 conda-forge 社区频道：：
$ conda install -c conda-forge sphinx
特定于操作系统的包管理器¶
您可以使用特定于操作系统的包管理器将Sphinx的全球版本安装到系统中。然而，请注意，这不太灵活，如果您想跨不同的项目工作，您可能会遇到兼容性问题。
Linux¶
Debian/Ubuntu¶
安装以下任一 python3-sphinx 使用 apt-get ：
$ apt-get install python3-sphinx
如果它还不存在，这将为您安装Python。
Rhel，CentOS¶
安装 python-sphinx 使用 yum ：
$ yum install python-sphinx
如果它还不存在，这将为您安装Python。
其他发行版本¶
大多数Linux发行版的包存储库中都有Sphinx。通常，该包被称为 python3-sphinx ， python-sphinx 或 sphinx 。请注意，至少还有另外两个包含 sphinx 以他们的名字命名的：语音识别工具包( CMU Sphinx )和全文搜索数据库( Sphinx search )。
MacOS¶
Sphinx可以使用安装 Homebrew, MacPorts.
自制酒¶
$ brew install sphinx-doc
有关更多信息，请参阅 package overview.
MacPorts¶
安装以下任一 python3x-sphinx 使用 port ：
$ sudo port install py313-sphinx
若要设置可执行文件路径，请使用 port select 命令：
$ sudo port select --set python python313
$ sudo port select --set sphinx py313-sphinx
有关更多信息，请参阅 package overview.
窗口¶
Sphinx可以使用安装 Chocolatey.
Chocolatey¶
$ choco install sphinx
您将需要 install Chocolatey 在运行这个程序之前。
有关更多信息，请参阅 chocolatey page.
Docker¶
有关Sphinx的Docker图像发布在 Docker Hub 。有两种图像：
前者用于Sphinx的标准用法，后者主要用于使用LaTeX的PDF构建。请根据您的目的选择一个。
备注
Sphinxdoc/sphinx-latexpdf包含TeXLive包。所以图像非常大(超过2 GB！)。
提示
当使用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
有关更多详细信息，请阅读 README file 码头的图像。
安装最新开发版本¶
您可以安装最新的开发， PyPI 使用 --pre 旗帜：：
$ pip install -U --pre sphinx
警告
您通常不需要（或想要）这样做，但如果您在最新的稳定版本中看到可能的错误，这可能会很有用。
从源安装¶
您可以直接从 Git repository. 这可以通过克隆Repo并从本地克隆安装来完成，只需通过直接安装即可 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 如上段所述。