sphinx-build hard-codes the python path into the exe about sphinx HOT 7 CLOSED

Hey @dylanh724, sphinx uses the standard Python declaration for scripts:

sphinx/pyproject.toml

Lines 106 to 107 in c41aab8

	[project.scripts]
	sphinx-build = "sphinx.cmd.build:main"

So if there is a problem it would likely lie with flit or pip (I've never encountered this problem, but then I don't use windows and also no idea what chocolatey is)

Alternatively, you can more specifically target the correct Python executable using: python -m sphinx.cmd.build, let me know if that works

Got it --

 WARNING: The scripts sphinx-apidoc.exe, sphinx-autogen.exe, sphinx-build.exe and sphinx-quickstart.exe are installed in 'C:\Users\dylan\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\Scripts' which is not on PATH.
  Consider adding this directory to PATH

It turns out that the Microsoft Store variant of Python does not include /Scripts to path (strange since they add python/pip to path).

Since they have a really wild path/to (you can't even view the dir in Windows - it's encrypted from yourself with access denied if you attempt to browse), this warning is the only chance to find where the correct path/to/Scripts/ actually is.

Windows...

This is the most official way to get Python these days, so you'll probably start seeing more tickets like this @chrisjsewell - thanks for the speedy response.

from sphinx.

@zooba that's exactly what I already said 😅 #12342 (comment)

from sphinx.

Hey @dylanh724, sphinx uses the standard Python declaration for scripts:

So if there is a problem it would likely lie with flit or pip
(I've never encountered this problem, but then I don't use windows and also no idea what chocolatey is)

Alternatively, you can more specifically target the correct Python executable using: python -m sphinx.cmd.build,
let me know if that works

from sphinx.

TL;DR

Windows users that installed from Microsoft Store should add the following path to their user env var:

C:\Users\{user}\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\Scripts

⚠️Replacing {user}

from sphinx.

^ @chrisjsewell Hmm... you know, it may be worth including this in the Windows install doc if they get a command not found err. If this isn't a common issue yet, it will be.

from sphinx.

Rather than telling users to modify PATH, I'd recommend you make sure that python -m sphinx build (or some similar spelling) works, and let people use that. It is significantly more robust for global installs than using the generated script executables (though those tend to be just fine in a virtual environment).

from sphinx.

Perhaps this should be in the install docs?

pip install -U sphinx

After installation, type sphinx-build --version on the command prompt. 

Eg, add the prefix here.

from sphinx.