Команда sphinx-build не найдена.

Это был наш процесс установки Sphinx.

> choco install python -y -f
> pip install sphinx

Мы знаем, что sphinx установлен из-за следующего вывода.

> pip show sphinx
---
Metadata-Version: 2.0
Name: Sphinx
Version: 1.4.3
Summary: Python documentation generator
Home-page: http://sphinx-doc.org/
Author: Georg Brandl
Author-email: [email protected]
License: BSD
Location: c:\programdata\chocolatey\lib\python3\tools\lib\site-packages

Мы также добавили его место установки в наш PATH.

c:\programdata\chocolatey\lib\python3\tools\lib\site-packages

Даже в этом случае запуск sphinx-build не работает.

'sphinx-build' is not recognized as an internal or external command,
operable program or batch file.

person Shaun Luttin    schedule 10.06.2016    source источник


Ответы (7)


Я тоже столкнулся с этой проблемой, когда установил Sphinx с помощью pip. Проблема была решена способом установки, предложенным в официальной документации:

Для Питона 3:

$ apt-get install python3-sphinx

Для Питона 2:

$ apt-get install python-sphinx
person Symon    schedule 09.06.2018
comment
Я получаю ту же ошибку, когда устанавливаю sphinx из pip в Ubuntu через конвейер Jenkins. Конвейер Jenkins терпит неудачу с command was not found, а затем работает со второй попытки - возможно, дело в пути/среде? Локально я использую Windows, и установка Sphinx работает нормально. - person H.Scheidl; 19.11.2018
comment
Это не работает для Ubuntu 18.04 LTS, поскольку apt-get упаковывает устаревшую версию sphinx, которая несовместима с версией, установленной pip... - person Thomas; 23.01.2020
comment
@ H.Scheidl Вы когда-нибудь находили решение для Дженкинса? Он работает на моей машине через docker-compose, но не работает в Jenkins. - person Marc LaBelle; 22.04.2020

Для macOS Мохаве:

$ brew install sphinx-doc

после установки brew уведомит вас добавить его в ваш путь, поэтому добавьте следующую строку в свой ~/.bash_profile:

export PATH="/usr/local/opt/sphinx-doc/bin:$PATH"

после этого вы можете запустить команду sphinx-build (вы можете проверить это, например, проверив версию)

$ sphinx-build --version
sphinx-build 2.0.1
person Kim Paulissen    schedule 29.04.2019
comment
Должно быть export PATH="/opt/homebrew/opt/sphinx-doc/bin:$PATH" для компьютеров Mac M1 ARM. - person cgnorthcutt; 18.04.2021

Для Windows:

Установка пути python в make.bat устранила проблему для меня:

set SPHINXBUILD="D:\Python3\Scripts\sphinx-build.exe"
person user9718458    schedule 14.02.2019

Мы добавили в путь неверный каталог.

Неправильный:

c:\programdata\chocolatey\lib\python3\tools\lib\site-packages

Верно:

c:\programdata\chocolatey\lib\python3\tools\Scripts
person Shaun Luttin    schedule 10.06.2016

Я решил проблему, просто установив из pip и перезапустив терминал.

person Harshil Mehta    schedule 30.06.2021

Для добавления macports

export PATH="/opt/local/Library/Frameworks/Python.framework/Versions/3.7/bin:$PATH"

в $HOME/.bash_profile устранена проблема

person Wolfgang Fahl    schedule 31.01.2020

Альтернативным способом вызова sphinx-build является явная загрузка модуля сборки Sphinx.

Для Сфинкса v1.7+:

python -m sphinx.cmd.build

Вот пример того, что я сделал с моей документацией:

$ python3 -m sphinx.cmd.build -b html docs/ docs/build/
Running Sphinx v4.0.2
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] api                                                                      
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index                                                                     
generating indices... genindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in docs/build.

Мне пришла в голову идея попытаться загрузить модуль с помощью этого ответа, первоначально для sphinx-quickstart.
Удивительно, но мне это удалось .

person Makiyu    schedule 14.06.2021