René's URL Explorer Experiment

Title: Docs: Create venv if missing by hugovk · Pull Request #98266 · python/cpython · GitHub

Open Graph Title: Docs: Create venv if missing by hugovk · Pull Request #98266 · python/cpython

X Title: Docs: Create venv if missing by hugovk · Pull Request #98266 · python/cpython

Description: Problem I started getting this error: $ make -C Doc clean rm -rf ./venv rm -rf build/* $ make -C Doc html mkdir -p build Building NEWS from Misc/NEWS.d with blurb PATH=./venv/bin:$PATH sphinx-build -b html -d build/doctrees -j auto -W . build/html Running Sphinx v5.1.1 making output directory... done Theme error: no theme named 'python_docs_theme' found (missing theme.conf?) make: *** [build] Error 2 That's because I have no venv so it can't find the theme. The problem is we have this, which looks for Sphinx in the venv or $PATH: SPHINXBUILD = PATH=$(VENVDIR)/bin:$$PATH sphinx-build And in my case it's finding it in my $PATH, so this guard passes: cpython/Doc/Makefile Line 55 in b863b9c elif $(BLURB) help >/dev/null 2>&1 && $(SPHINXBUILD) --version >/dev/null 2>&1; then \ But I don't get this warning: cpython/Doc/Makefile Lines 65 to 66 in b863b9c echo "Missing the required blurb or sphinx-build tools."; \ echo "Please run 'make venv' to install local copies."; \ Fix Two things (aka let's do it like the devguide) let's just use the tools in the venv, not $PATH (to make the guard fail, and show the warning): https://github.com/python/devguide/blob/05f6d0c8d09bd757440e0346190dbd62e06c7251/Makefile#L9-L10 and add ensure-venv target that will install the venv if the venv dir is missing (to avoid the warning in the first place): https://github.com/python/devguide/blob/05f6d0c8d09bd757440e0346190dbd62e06c7251/Makefile#L58-L64 Bonus Whilst we're changing Docs/Makefile, PR #98189 recently fixed some missing .PHONY targets. 👍 I expect missing .PHONY targets will happen again, because it's normal to copy/paste a target, and forget (or not know) to update the long .PHONY line right at the top. Let's do as @zware suggested and define them right next to each target: #98189 (comment) We do this at Pillow and at work, it helps a lot. (I'll add it to the devguide and PEPs too.)

Open Graph Description: Problem I started getting this error: $ make -C Doc clean rm -rf ./venv rm -rf build/* $ make -C Doc html mkdir -p build Building NEWS from Misc/NEWS.d with blurb PATH=./venv/bin:$PATH sphinx-build...

X Description: Problem I started getting this error: $ make -C Doc clean rm -rf ./venv rm -rf build/* $ make -C Doc html mkdir -p build Building NEWS from Misc/NEWS.d with blurb PATH=./venv/bin:$PATH sphinx-build...

Opengraph URL: https://github.com/python/cpython/pull/98266

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width