安装¶
Linux¶
Debian/Ubuntu¶
使用 apt-get 安装 python3-sphinx (Python 3) 或 python-sphinx (Python 2):
$ apt-get install python3-sphinx
如果它还没有出现，这将为您安装Python。
其他发行版¶
大多数Linux发行版都在其软件包存储库中安装了Sphinx。通常这个包被称为 python3-sphinx ， python-sphinx 或 sphinx 。 请注意，其名称中至少还有两个名为 sphinx 的软件包:语音识别工具包(CMU Sphinx)和全文搜索数据库(Sphinx搜索)。
macOS¶
Sphinx可以使用 Homebrew, MacPorts, 安装，或者作为Python发行版的一部分安装，例如 Anaconda.
MacPorts¶
使用 port 安装 python36-sphinx (Python 3)或 python27-sphinx (Python 2):
$ sudo port install py36-sphinx
要设置可执行文件路径，请使用 port select 命令:
$ sudo port select --set python python36
$ sudo port select --set sphinx py36-sphinx
有关更多信息，请参阅 package overview.
Anaconda¶
$ conda install sphinx
Windows¶
待处理
我们可以开始打包吗？
大多数Windows用户默认没有安装Python，因此我们首先安装Python本身。 如果您不确定，请打开 命令提示符 (⊞Win-r 并输入 cmd) 打开命令提示符后，键入 python --version 并按Enter键。 如果Python可用，您将看到在屏幕上打印的Python版本。 如果您没有安装Python，请参阅Windows安装指南中的 Hitchhikers Guide to Python’s Python”。 你必须安装 Python 3。
安装Python后，您可以使用 pip 安装Sphinx 。有关更多信息，请参阅下面的 pip installation instructions 。
从PyPI安装¶
Sphinx包发布在 Python Package Index 上。 从 PyPI 安装软件包的首选工具是 pip 。 此工具随Python的所有现代版本一起提供。
在Linux或MacOS上，您应该打开终端并运行以下命令。
$ pip install -U sphinx
在Windows上，您应该打开 命令提示符 ( ⊞Win-r 并键入 cmd )并运行相同的命令。
C:\> pip install -U sphinx
安装完成后，在命令提示符下键入 sphinx-build --version 。如果一切正常，您将看到刚安装的Sphinx软件包的版本号。
从*PyPI*安装也允许您安装最新的开发版本。您通常不需要(或想要)这样做，但如果您在最新的稳定版本中看到可能的错误，它会很有用。为此，请使用 --pre 标志。
$ pip install -U --pre sphinx
从源代码安装¶
您可以直接从 Git repository 的克隆安装Sphinx。这可以通过克隆repo并从本地克隆安装，只需通过 git 直接安装即可完成。
$ git clone https://github.com/sphinx-doc/sphinx
$ cd sphinx
$ pip install .
$ pip install git+https://github.com/sphinx-doc/sphinx
您也可以用 tar.gz 或 zip 格式下载 Git repo 的快照。下载并解压缩后，可以使用以下命令安装 pip 。