[Python-checkins] devguide: Issue #15311: Expand section on helping with the Developer's Guide

ned.deily python-checkins at python.org
Sat Jul 28 00:15:50 CEST 2012


http://hg.python.org/devguide/rev/706b1fa362a4
changeset:   532:706b1fa362a4
user:        Ned Deily <nad at acm.org>
date:        Fri Jul 27 15:15:18 2012 -0700
summary:
  Issue #15311: Expand section on helping with the Developer's Guide
documentation.  (Patch by Chris Jerdonek)

files:
  docquality.rst |  14 ++++++++++----
  1 files changed, 10 insertions(+), 4 deletions(-)


diff --git a/docquality.rst b/docquality.rst
--- a/docquality.rst
+++ b/docquality.rst
@@ -69,8 +69,14 @@
 Helping with the Developer's Guide
 ----------------------------------
 
-This developer guide lives in a `separate source code repository`_, but is
-otherwise managed using the same process as is used for the main Python
-documentation.
+The Developer's Guide uses the same process as the main Python
+documentation, except for some small differences.
+The source lives in a `separate repository`_. To build and view the
+documentation, install `Sphinx`_ and issue the following command: ::
 
-.. _separate source code repository: http://hg.python.org/devguide
+   make html
+
+Changes to the documentation are published immediately using an update hook.
+
+.. _separate repository: http://hg.python.org/devguide
+.. _Sphinx: http://sphinx.pocoo.org/

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


More information about the Python-checkins mailing list