安装Sphinx¶
概述¶
Sphinx是用 `Python`__ 并支持Python3.9+。它建立在许多第三方库的肩膀上，例如 `Docutils`__ 和 `Jinja`_ _，它们在安装Sphinx时安装。
Linux系统¶
Debian／Ubuntu¶
安装任何一个 python3-sphinx 使用 apt-get ：
$ apt-get install python3-sphinx
如果它还没有出现，这将为您安装python。
世纪之交¶
安装 python-sphinx 使用 yum ：
$ yum install python-sphinx
如果它还没有出现，这将为您安装python。
其他分配¶
大多数Linux发行版在其软件包存储库中都有sphinx。通常称为包 python3-sphinx ， python-sphinx 或 sphinx . 请注意，至少还有两个 sphinx 以他们的名义：语音识别工具包（ CMUSphinx ）和全文搜索数据库（ Sphinx搜索 ）
macOS¶
可以使用 `Homebrew`__ , `MacPorts`__ 或者作为python发行版的一部分，例如 `Anaconda`__ .
Homebrew¶
$ brew install sphinx-doc
有关详细信息，请参阅 `package overview`__ 。
MacPorts¶
安装任何一个 python3x-sphinx 使用 port ：
$ sudo port install py39-sphinx
要设置可执行路径，请使用 port select 命令：
$ sudo port select --set python python39
$ sudo port select --set sphinx py39-sphinx
有关详细信息，请参阅 `package overview`__ 。
Python¶
$ conda install sphinx
Windows¶
可以使用以下工具安装Sphinx `Chocolatey`__ 或 installed manually 。
巧克力味¶
$ choco install sphinx
您将需要 install Chocolatey 在运行这个程序之前。
有关更多信息，请参阅 `chocolatey page`__.
其他方法¶
Most Windows users do not have Python installed by default, so we begin with the installation of Python itself. To check if you already have Python installed, open the Command Prompt (⊞Win-r and type cmd). Once the command prompt is open, type python --version and press Enter. If Python is installed, you will see the version of Python printed to the screen. If you do not have Python installed, refer to the `Hitchhikers Guide to Python's`__ Python on Windows installation guides. You must install `Python 3`__.
一旦安装了python，就可以使用 pip . 参考 pip installation instructions 详情请参见下文。
从PYPI安装¶
Sphinx套装发布在 Python Package Index . 安装程序包的首选工具 PyPI 是 pip . 这个工具提供了所有现代版本的python。
在Linux或MacOS上，您应该打开终端并运行以下命令。
$ pip install -U sphinx
在窗户上，你应该打开 命令提示符 (⊞Win-r 类型 cmd ）运行相同的命令。
C:\> pip install -U sphinx
安装后，类型 sphinx-build --version 在命令提示下。如果一切正常，您将看到刚刚安装的sphinx软件包的版本号。
安装自 PyPI 还允许您安装最新的开发版本。您通常不需要（或不想）这样做，但是如果您在最新的稳定版本中看到一个可能的bug，它会很有用。为此，请使用 --pre 旗帜。
$ pip install -U --pre sphinx
使用虚拟环境¶
使用pip安装Sphinx时，强烈建议使用 virtual environments ，它将已安装的程序包与系统程序包隔离，从而消除了使用管理员权限的需要。在中创建虚拟环境 .venv 目录中，使用以下命令。
$ python -m venv .venv
参见
venv --创建虚拟环境
警告
请注意，在某些Linux发行版中，例如Debian和Ubuntu，这可能需要如下所示的额外安装步骤。
$ apt-get install python3-venv
码头工人¶
有关Sphinx的Docker图像发布在 Docker Hub 。有两种图像：
前者用于Sphinx的标准用法，后者主要用于使用LaTeX的PDF构建。请根据您的目的选择一个。
备注
sphinxdoc/sphinx latexpdf包含TeXLive包。所以图像非常大（超过2GB！）。
提示
当使用停靠器图像时，请使用 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`_ _关于docker图像。
从源安装¶
您可以直接从 `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 repo的快照： `tar.gz`__ 或 `zip`__ 格式。下载和提取后，可以使用 pip 如上所述。