8000 bpo-31036: Allow sphinx and blurb to be found automatically by ned-deily · Pull Request #3440 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

bpo-31036: Allow sphinx and blurb to be found automatically #3440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Sep 8, 2017
Merged

bpo-31036: Allow sphinx and blurb to be found automatically #3440

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e488b82
Make the directory for the venv be configurable
brettcannon Jul 30, 2017
5188abe
Expand on possible Doc venv directory names
brettcannon Jul 30, 2017
7f668ee
Print out where the Doc venv was created
brettcannon Jul 30, 2017
a5929bd
Document the `make venv` target for the docs
brettcannon Jul 30, 2017
955f669
Put the venv directory back to what it was
brettcannon Jul 31, 2017
2e558d4
Set SPHINXBUILD to use `-m` for greater flexibility
brettcannon Jul 31, 2017
c8365f9
Merge rest of current blurb support
ned-deily Sep 7, 2017
860b3b3
Allow sphinx-build and blurb to be found on PATH if venv not present
ned-deily Sep 7, 2017
1f3dcee
"make html" no longer needs PYTHON=
ned-deily Sep 7, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Allow sphinx-build and blurb to be found on PATH if venv not present
  • Loading branch information
@ned-deily
ned-deily committed Sep 7, 2017
commit 860b3b36d834ddb2a0738a3dc8e1650fa89bcf86
8 changes: 4 additions & 4 deletions Doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

# You can set these variables from the command line.
PYTHON = python3
VENVDIR = venv
SPHINXBUILD = $(PYTHON) -m sphinx
BLURB = $(PYTHON) -m blurb
VENVDIR = ./venv
SPHINXBUILD = PATH=$(VENVDIR)/bin:$$PATH sphinx-build
BLURB = PATH=$(VENVDIR)/bin:$$PATH blurb
PAPER =
SOURCES =
DISTVERSION = $(shell $(PYTHON) tools/extensions/patchlevel.py)
8000 Expand Down Expand Up @@ -123,7 +123,7 @@ clean:

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

dist:
Expand Down
4 changes: 4 additions & 0 deletions Doc/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ build the HTML output files::

make html PYTHON=./env/bin/python

By default, if the virtual environment is not created, the Makefile will
look for instances of sphinxbuild and blurb installed on your process PATH
(configurable with the SPHINXBUILD and BLURB variables).

On Windows, we try to emulate the Makefile as closely as possible with a
``make.bat`` file. If you need to specify the Python interpreter to use,
set the PYTHON environment variable instead.
Expand Down
0