Skip to content

Commit

Permalink
[2.7] bpo-31036: Allow sphinx and blurb to be found automatically (py…
Browse files Browse the repository at this point in the history
…thonGH-16638)

Rather than requiring the path to blurb and/or sphinx-build to be specified to the make rule, enhance the Doc/Makefile to look for each first in a virtual environment created by make venv and, if not found, look on the normal process PATH. This allows the Doc/Makefile to take advantage of an installed spinx-build or blurb and, thus, do the right thing most of the time. Also, make the directory for the venv be configurable and document the `make venv` target..
(cherry picked from commit 590665c)

Co-authored-by: Ned Deily <[email protected]>
  • Loading branch information
benjaminp and ned-deily authored Oct 8, 2019
1 parent e78d79c commit 0bd59d6
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
*.profraw
*.dyn
Doc/build/
Doc/tools/docutils/
Doc/tools/jinja2/
Doc/tools/pygments/
Doc/tools/sphinx/
Doc/venv/
Doc/.venv/
Doc/env/
Doc/.env/
Lib/lib2to3/*.pickle
Lib/test/data/*
Makefile
Expand Down
13 changes: 10 additions & 3 deletions Doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@

# You can set these variables from the command line.
PYTHON = python
SPHINXBUILD = sphinx-build
VENVDIR = ./venv
SPHINXBUILD = PATH=$(VENVDIR)/bin:$$PATH sphinx-build
BLURB = PATH=$(VENVDIR)/bin:$$PATH blurb
PAPER =
SOURCES =
DISTVERSION = $(shell $(PYTHON) tools/extensions/patchlevel.py)
Expand Down Expand Up @@ -102,7 +104,12 @@ htmlview: html
$(PYTHON) -c "import webbrowser; webbrowser.open('build/html/index.html')"

clean:
-rm -rf build/*
-rm -rf build/* $(VENVDIR)/*

venv:
$(PYTHON) -m venv $(VENVDIR)
$(VENVDIR)/bin/python3 -m pip install -U Sphinx blurb
@echo "The venv has been created in the $(VENVDIR) directory"

dist:
rm -rf dist
Expand Down Expand Up @@ -148,7 +155,7 @@ dist:
cp -pPR build/epub/Python.epub dist/python-$(DISTVERSION)-docs.epub

check:
$(PYTHON)2 tools/rstlint.py -i tools
$(PYTHON)2 tools/rstlint.py -i tools -i $(VENVDIR)

serve:
../Tools/scripts/serve.py build/html
Expand Down

0 comments on commit 0bd59d6

Please sign in to comment.