]> granicus.if.org Git - python/commitdiff
Issue #22394: Add a 'venv' command to Doc/Makefile.
authorBrett Cannon <brett@python.org>
Fri, 5 Dec 2014 20:17:31 +0000 (15:17 -0500)
committerBrett Cannon <brett@python.org>
Fri, 5 Dec 2014 20:17:31 +0000 (15:17 -0500)
This will create a venv using the interpreter specified by the PYTHON
variable for the Makefile that also install Sphinx. Typical usage is
expected to be:

  cd Doc
  make venv PYTHON=../python
  make html PYTHON=venv/bin/python3

.gitignore
.hgignore
Doc/Makefile
Misc/NEWS

index c7db0c7687b698cb30738e13ed173e1fca9c0346..2343e9430e9936b3c0ec959200a9cc398598300c 100644 (file)
@@ -9,11 +9,7 @@
 *~
 .gdb_history
 Doc/build/
-Doc/tools/docutils/
-Doc/tools/jinja/
-Doc/tools/jinja2/
-Doc/tools/pygments/
-Doc/tools/sphinx/
+Doc/venv/
 Lib/lib2to3/*.pickle
 Lib/test/data/*
 Lib/_sysconfigdata.py
index e22a8f7c4ca4351c15014375a258341e4644b49c..d22a58af462cd5a8a8ffe37e0a5741f3bcd0b420 100644 (file)
--- a/.hgignore
+++ b/.hgignore
@@ -9,6 +9,7 @@ TAGS$
 autom4te.cache$
 ^build/
 ^Doc/build/
+^Doc/venv/
 buildno$
 config.cache
 config.log
index 5b5f68a0f3e06837fab93e3769dea4e59e08b488..93e59efe62e54a9c3edab26f5e14cd593732aa50 100644 (file)
@@ -15,11 +15,12 @@ ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_paper_size=$(PAPER) \
 
 .PHONY: help build html htmlhelp latex text changes linkcheck \
        suspicious coverage doctest pydoc-topics htmlview clean dist check serve \
-       autobuild-dev autobuild-stable
+       autobuild-dev autobuild-stable venv
 
 help:
        @echo "Please use \`make <target>' where <target> is one of"
        @echo "  clean      to remove build files"
+       @echo "  venv       to create a venv with necessary tools"
        @echo "  html       to make standalone HTML files"
        @echo "  htmlview   to open the index page built by the html target in your browser"
        @echo "  htmlhelp   to make HTML files and a HTML help project"
@@ -102,7 +103,11 @@ htmlview: html
         $(PYTHON) -c "import webbrowser; webbrowser.open('build/html/index.html')"
 
 clean:
-       -rm -rf build/*
+       -rm -rf build/* venv/*
+
+venv:
+       $(PYTHON) -m venv venv
+       ./venv/bin/python3 -m pip install -U Sphinx
 
 dist:
        rm -rf dist
@@ -172,4 +177,3 @@ autobuild-stable:
                exit 1;; \
        esac
        @make autobuild-dev
-
index 496be4eaf70dc351de782970d7ded8d3a8d66c48..c7c8f8daf0c85d5b53e105393a1ee672429ea036 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -1348,6 +1348,10 @@ C API
 Documentation
 -------------
 
+- Issue #22394: Doc/Makefile now supports ``make venv PYTHON=../python`` to
+  create a venv for generating the documentation, e.g.,
+  ``make html PYTHON=venv/bin/python3``.
+
 - Issue #21514: The documentation of the json module now refers to new JSON RFC
   7159 instead of obsoleted RFC 4627.