bpo-44756: [docs] revert automated virtual environment creation on make html (GH-27635) (GH-27636)

It turned out to be disruptive for downstream distributors.
(cherry picked from commit 55fa87b1ef)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
This commit is contained in:
Miss Islington (bot) 2021-08-06 11:42:27 -07:00 committed by GitHub
parent 8c07fef867
commit 91f6d38669
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 5 deletions

View file

@ -45,7 +45,7 @@ help:
@echo " check to run a check for frequent markup errors" @echo " check to run a check for frequent markup errors"
@echo " serve to serve the documentation on the localhost (8000)" @echo " serve to serve the documentation on the localhost (8000)"
build: venv build:
-mkdir -p build -mkdir -p build
# Look first for a Misc/NEWS file (building from a source release tarball # Look first for a Misc/NEWS file (building from a source release tarball
# or old repo) and use that, otherwise look for a Misc/NEWS.d directory # or old repo) and use that, otherwise look for a Misc/NEWS.d directory
@ -145,7 +145,8 @@ clean-venv:
venv: venv:
@if [ -d $(VENVDIR) ] ; then \ @if [ -d $(VENVDIR) ] ; then \
echo "venv already exists"; \ echo "venv already exists."; \
echo "To recreate it, remove it first with \`make clean-venv'."; \
else \ else \
$(PYTHON) -m venv $(VENVDIR); \ $(PYTHON) -m venv $(VENVDIR); \
$(VENVDIR)/bin/python3 -m pip install -U pip setuptools; \ $(VENVDIR)/bin/python3 -m pip install -U pip setuptools; \

View file

@ -29,13 +29,20 @@ Using make
---------- ----------
To get started on UNIX, you can create a virtual environment and build To get started on UNIX, you can create a virtual environment and build
documentation with the command:: documentation with the commands::
make venv
make html make html
The virtual environment in the ``venv`` directory will contain all the tools The virtual environment in the ``venv`` directory will contain all the tools
necessary to build the documentation. You can also configure where the virtual necessary to build the documentation downloaded and installed from PyPI.
environment directory will be with the ``VENVDIR`` variable. If you'd like to create the virtual environment in a different location,
you can specify it using the ``VENVDIR`` variable.
You can also skip creating the virtual environment altogether, in which case
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 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, ``make.bat`` file. If you need to specify the Python interpreter to use,

View file

@ -0,0 +1,3 @@
Reverted automated virtual environment creation on ``make html`` when
building documentation. It turned out to be disruptive for downstream
distributors.