Commit55fa87b

authored

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

It turned out to be disruptive for downstream distributors.

1 parent8bdf12e commit55fa87bCopy full SHA for 55fa87b

File tree

+16

-5

lines changed

+16

-5

lines changed

Lines changed: 3 additions & 2 deletions

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

Lines changed: 10 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -29,13 +29,20 @@ Using make`
`29`	`29`	`----------`
`30`	`30`
`31`	`31`	`To get started on UNIX, you can create a virtual environment and build`
`32`		`-documentation with thecommand::`
	`32`	`+documentation with thecommands::`
`33`	`33`
	`34`	`+ make venv`
`34`	`35`	`make html`
`35`	`36`
`36`	`37`	The virtual environment in the ``venv`` directory will contain all the tools
`37`		`-necessary to build the documentation. You can also configure where the virtual`
`38`		-environment directory will be with the ``VENVDIR`` variable.
	`38`	`+necessary to build the documentation downloaded and installed from PyPI.`
	`39`	`+If you'd like to create the virtual environment in a different location,`
	`40`	+you can specify it using the ``VENVDIR`` variable.
	`41`	`+`
	`42`	`+You can also skip creating the virtual environment altogether, in which case`
	`43`	+the Makefile will look for instances of ``sphinxbuild`` and ``blurb``
	`44`	+installed on your process ``PATH`` (configurable with the ``SPHINXBUILD`` and
	`45`	+``BLURB`` variables).
`39`	`46`
`40`	`47`	`On Windows, we try to emulate the Makefile as closely as possible with a`
`41`	`48`	``make.bat`` file. If you need to specify the Python interpreter to use,

Lines changed: 3 additions & 0 deletions

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

Comments

(0)