[Python-checkins] devguide: update for recent changes in doc building

benjamin.peterson python-checkins at python.org
Fri Sep 5 05:26:01 CEST 2014


http://hg.python.org/devguide/rev/2ed6c4b04334
changeset:   711:2ed6c4b04334
user:        Benjamin Peterson <benjamin at python.org>
date:        Thu Sep 04 23:25:50 2014 -0400
summary:
  update for recent changes in doc building

files:
  documenting.rst |  17 +++++++++--------
  1 files changed, 9 insertions(+), 8 deletions(-)


diff --git a/documenting.rst b/documenting.rst
--- a/documenting.rst
+++ b/documenting.rst
@@ -1451,13 +1451,8 @@
 below.  You can view the documentation after building the HTML by pointing
 a browser at the file :file:`Doc/build/html/index.html`.
 
-In the Python 2.7 and 3.3 branches, the Sphinx toolchain will be checked out
-using Subversion from ``svn.python.org`` by the Makefile.  This toolchain will
-need an installed Python 2 to run.
-
-In the Python 3.4 and later branches, you are expected to have installed a
-recent version of Sphinx on your system, so that the Makefile can find the
-``sphinx-build`` command.
+You are expected to have installed a recent version of Sphinx on your system or
+in a virtualenv_, so that the Makefile can find the ``sphinx-build`` command.
 
 
 Using make / make.bat
@@ -1469,7 +1464,9 @@
    cd Doc
    make html
 
-or alternatively ``make -C Doc html``.  This builds the output as HTML.
+or alternatively ``make -C Doc html``.  This builds the output as HTML.  You can
+specify the location of the ``sphinx-build`` command with the ``SPHINXBUILD``
+make variable.
 
 For Windows users there is a :file:`make.bat` batchfile that tries to work like
 ``make`` does.
@@ -1478,6 +1475,9 @@
 
  * "html", which builds standalone HTML files for offline viewing.
 
+ * "htmlview", which builds the standalone HTML files and then opens a web
+   browser to display them.
+
  * "htmlhelp", which builds HTML files and a HTML Help project file usable to
    convert them into a single Compiled HTML (.chm) file -- these are popular
    under Microsoft Windows, but very handy on every platform.
@@ -1526,3 +1526,4 @@
 .. _Jinja: http://jinja.pocoo.org/
 .. _Pygments: http://pygments.org/
 .. _Sphinx: http://sphinx-doc.org/
+.. _virtualenv: https://virtualenv.pypa.io/

-- 
Repository URL: http://hg.python.org/devguide


More information about the Python-checkins mailing list