Sphinx 快速启动不起作用

Question

我正在尝试在远程计算机上安装 sphinx。

由于我无法访问根目录，所以我这样做了：

$bash

$mkdir -p ~/local/lib/python2.7/site-packages

$export PYTHONPATH=$PYTHONPATH:~/local/lib/python2.7/site-packages

$export PATH=$PATH::~/local/lib/python2.7/site-packages

$easy_install -U --prefix=$HOME/local Sphinx

但显然，

$easy_install

并没有构建sphinx-quickstart；当我输入

$sphinx-quickstart

我收到以下消息：

bash: sphinx-quickstart: command not found

我试过了

find $HOME -name sphinx-quickstart 

没有找到结果。不过，我可以在 python 中导入 sphinx:

$python

然后

>>import sphinx 

有效。知道为什么

sphinx-quickstart

不起作用吗？

Answer 1

调用

sphinx-quickstart

的另一种方法是显式加载 Sphinx 的快速启动模块。对于 Sphinx v1.7+：

python -m sphinx.cmd.quickstart

对于旧版本的 Sphinx：

python -m sphinx.quickstart

例如：

$ /c/Python35/python -m sphinx.quickstart
Welcome to the Sphinx 1.6.2 quickstart utility.
...

Answer 2

我在这个网页找到了解决方案：

用户（无需 root/sudo）安装 Python 模块。

在第 3 节中。 Python 2.6+他提到命令行命令在

~/local/bin

虽然我已经将

~/local/lib/python2.7/siste-packages

放入路径中，但

~/local/bin

目录不在路径中。所以我所做的一切

$export PYTHONPATH=$PYTHONPATH:~/local/bin

现在可以了。

不知道为什么

find $HOME -name sphinx-quickstart

没有找到

sphinx-quickstart

Answer 3

在 MacOS (Catalina) 和 zsh 中：

我用brew安装了sphinx，遇到了和你一样的问题。

解决方案： 使用 conda 作为

conda install sphinx

安装它，现在它对我有用

$ sphinx-quickstart
Welcome to the Sphinx 2.3.0 quickstart utility.

安装指南

Answer 4

注意，如果你在虚拟环境中并使用诗歌来运行

poetry run py -m sphinx.cmd.quickstart

其中

py

是 Windows 的 python 启动器。

Answer 5

已添加使用brew在macOS上安装的答案here

对于新用户，使用brew安装需要注意以下事项：

==> sphinx-doc
sphinx-doc is keg-only, which means it was not symlinked into /usr/local,
because this formula is mainly used internally by other formulae.
Users are advised to use `pip` to install sphinx-doc.

If you need to have sphinx-doc first in your PATH, run:
  echo 'export PATH="/usr/local/opt/sphinx-doc/bin:$PATH"' >> ~/.zshrc

运行 echo 命令：

echo 'export PATH="/usr/local/opt/sphinx-doc/bin:$PATH"' >> ~/.zshrc

应该可以解决问题。

更新后不要错过

source

-ing .zshrc：

source ~/.zshrc

Answer 6

我发现跑步

python "path to sphinx-quickstart-script.py"

作品。当时我正在使用 micromamba，所以我必须先激活我的环境，然后在我的 VS code 终端中运行它。