如何强制Sphinx使用Python 3.x解释器

Question

我尝试为使用 Python 3.x 编写的项目创建文档。 Sphinx 是我想要使用的工具，并且根据< a href="http://sphinx.pocoo.org/changes.html" rel="noreferrer">官方网站，最新版本1.1.2兼容Python 3.1+。我的操作系统是 Archlinux，一个使用 Python 3.2+ 作为默认 Python 包的 Linux 发行版。

安装和配置非常简单（easy_install -U Sphinx 然后 sphinx-quickinstall），并且从未要求我在 2.x 或 3.x Python 解释器之间进行选择。但是当我要求 Sphinx 创建我的项目的文档时，我的代码会被分析，就像我为 Python 2.x 编写的一样。

Sphinx 准备好支持 Python 3.x 了吗？我做错了吗？

Answer 1

安装：使用pip为python3安装sphinx（pip3就像这样）。

    pip3 install -U sphinx

构建： Makefile(linux/Mac) 更改。

    SPHINXBUILD   = python -msphinx

在 Makefile 的上面一行中，将 python 更改为 python3（或 python3.x），就像

   SPHINXBUILD   = python3 -msphinx

默认 python 指向 2.x 版本一样
Python。

Answer 2

在 Ubuntu 上，python3-sphinx 是一个单独的包。就我而言，我需要安装 python3-sphinx：

sudo apt-get install python3-sphinx

您可能可以在一台机器上运行两者，但我只是删除了旧的：

sudo apt-get remove python-sphinx

在此之后，我的旧 makefile 与我的 Python 3 代码一起工作得很好。

Answer 3

我来自未来（2020）。

我在让 Sphinx 与特定的 python 解释器和 Ubuntu 完美配合时遇到了问题。只是认为最新的答案可能会帮助其他在这里徘徊的人。

===================================

所以，首先要了解的是，如果您使用自动构建/安装选项，您仍然应该仔细检查您是否得到了您认为应该得到的东西。

例如，运行（按照 Sphinx 文档 顶部的建议）

apt install python3-sphinx

，然后在要构建自动文档的目录中运行 sphinx-quickstart 即可。但是，它将使用 Sphinx 1.6.7（在撰写本文时，最新的 Sphinx 版本是 3.0.3），因为该存储库显然没有维护。然后，如果您想使用一些 Sphinx 扩展（例如 sphinx-js，这就是我的情况），那么您可能会感到有点惊讶。

因此，我建议仅将这些自动打包安装用于简单的用例或测试或原型设计。

===========================================

更好的方法

使用 pip 安装 SPHINX（Py3 为 pip3）

pip3 install -U sphinx

现在您拥有最新的 pip3 版本，并且它正在与特定的已知解释器一起使用。您可以使用pip3 list仔细检查

初始化项目的autodoc

如果执行上述操作，sphinx-quickstart可能无法工作：找不到命令。我猜测 apt install 负责将一些脚本（例如 sphinx-quickstart）放入路径中。

但是您可以这样做：

python3 -m sphinx.cmd.quickstart 

在文档目录的根目录中。这将非常类似于 sphinx-quickstart。如果您想要更多功能，您可能需要向新创建的conf.py添加扩展。例如（有关详细信息，请参阅 Sphinx 的文档）：

extensions = ['sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
    'sphinx.ext.viewcode',
    'sphinx.ext.githubpages']

构建文档

最后，make html 如果以这种方式安装，则无法开箱即用。但是，您可以改为启动完整命令：

[pythonterpreter] -m sphinx.cmd.build -b [builder type] [path-to-conf.py] [path-output-directoy]

例如：

python3 -m sphinx.cmd.build -b html /home/anonymous/PycharmProjects/DocstringDemo/docstrings /home/anonymous/PycharmProjects/DocstringDemo/docstrings/_build

这很漂亮与 makefile 本身的作用差不多。

现在你已经安装了带有特定解释​​器的 Sphinx

Answer 4

昨晚，当我遇到你的问题时，我也遇到了同样的问题。 — 我也在 Arch 上。

我想问题可能有很多不同的原因，但对我来说，解决方案是我安装了 Python 2 版本的 python-distribute 软件包，因此安装了 easy_install-2.7而不是easy_install-3.2。

我相信在我的情况下，我之前尝试从 pacman 安装 Sphinx（安装版本 1.0.8）时安装了错误版本的 python-distribute，因此卸载 Sphinx 以及随后所有不需要的依赖项 pacman -Rsu python-sphinx 然后安装 python-distribute 得到了正确版本的 easy_install，然后重新安装 Sphinx easy_install 和 Sphinx 安装按预期工作。

如果您还有其他依赖于python-distribute的东西，那么过程可能会有点不同。但首先尝试删除 python-distribute 并从那里开始工作。

废弃最后一部分。时间太早了，我还没有好好思考！ python2-distribute 和 python-distribute 是单独的包，我相信它们可以共存。因此，如果这是您的问题，您需要做的就是检查您是否有 python-distribute （不是“2”），如果没有安装它，然后确保您使用 easy_install-3.2< /code> 安装 Sphinx。

希望这对您有帮助。

Answer 5

我在 Ubunut 也遇到了同样的问题。我不会使用 Josh_P 或 Nicolas 答案，因为..

• 我不想更改我的 PYTHON 路径。
• 我不想卸载 python-sphinx，因为我需要它与旧项目一起使用。

所以我用这个名为 sphinx3-build 的小脚本修复了它：

#!/usr/bin/python3
# -*- coding: utf-8 -*-
"""
Same as /usr/bin/sphinx-build but with different
interpreter
"""

import sys

if __name__ == '__main__':
    from sphinx import main, make_main
    if sys.argv[1:2] == ['-M']:
        sys.exit(make_main(sys.argv))
    else:
        sys.exit(main(sys.argv))

它与 sphinx-build 相同，但使用不同的解释器。
在 Makefile 中，我更改了以下行：

SPHINXBUILD   = sphinx3-build

现在将文件复制到 /usr/bin/ 文件夹：

sudo cp sphinx3-build /usr/bin/

这对我有用。您也可以在本地将其用于一个项目，只需将
将脚本放入与 Makefile 相同的文件夹中，并将 SPHINXBUILD 设置为
./sphinx3-build。

Answer 6

与已经提供的解决方案类似的解决方案是将对 sphinx.main() 的调用直接放入 Makefile 中的 SPHINXBUILD 变量中：

SPHINXBUILD   = python3 -c "import sys,sphinx;sys.exit(sphinx.main(sys.argv))"

sphinx 生成的“用户友好检查 sphinx-build”代码块失败，所以我只是将其删除它。这个解决方案对我来说更可取，因为它不需要单独的脚本，也不需要删除任何 python 安装或 sphinx 模块。

Answer 7

看来 Sphinx 的安装仅支持 Python-2。尽管有多种方法可以为 python3 安装 Sphinx，但只需使用 virtualenv 创建一个使用默认为python3。

virtualenv -p /path/to/python-3 foo

在 vi​​rtualenv 中安装 Sphinx：

pip install Sphinx

作为奖励，这种方法允许您为不同的环境创建自定义环境项目。

附言。您可能需要考虑使用 virtualenvwrapper。

Answer 8

当我寻找答案时，这个网站一遍又一遍地出现。我认为答案并不容易找到，因为其他人都比我更了解狮身人面像。但如果有人仍在寻找答案，这就是我最终得到的结果：

sudo apt-get update

sudo apt-get install python3

sudo apt-get install sqlite3

sudo apt-get installidle3

sudo apt-get install python3-pip

sudo apt-get 安装 python3-docutils

sudo apt-get 安装 python3-jinja2

sudo apt-get 安装 python3-pygments

sudo pip3 install Sphinx

关键是我错过了有一个 pip3 的事实。我也习惯在添加包之前更新系统。

Answer 9

我认为 Sphinx 只是使用“python”命令作为解释器。但根据 Makefile，您可以在运行 make 进行安装时使用 PYTHON 选项指定您自己的文件。