[Python-checkins] devguide: #15820: Improve the Helping with the Devguide section
r.david.murray
python-checkins at python.org
Sat Sep 8 23:51:43 CEST 2012
http://hg.python.org/devguide/rev/18e31605b161
changeset: 545:18e31605b161
user: R David Murray <rdmurray at bitdance.com>
date: Sat Sep 08 17:51:33 2012 -0400
summary:
#15820: Improve the Helping with the Devguide section
Original idea and initial patch by Mike Hoy. Blame me
for the actual result, though.
files:
docquality.rst | 37 ++++++++++++++++++++++++++++---------
index.rst | 5 ++---
2 files changed, 30 insertions(+), 12 deletions(-)
diff --git a/docquality.rst b/docquality.rst
--- a/docquality.rst
+++ b/docquality.rst
@@ -66,18 +66,37 @@
makes it harder to break the work up for multiple people to help with.
+.. _helping-with-the-developers-guide:
+
Helping with the Developer's Guide
----------------------------------
-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: ::
-
- make html
-
-Changes to the documentation are normally published within a day on a
-schedule that may be different from the main 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`_. Bug reports and and patches should be submitted to the `python
+bug tracker`_ using the ``devguide`` component. Changes to the devguide
+are normally published within a day, on a schedule that may be different from
+the main documentation.
.. _separate repository: http://hg.python.org/devguide
+.. _python bug tracker: http://bugs.python.org
+
+To clone the Developer's Guide:
+
+``hg clone http://hg.python.org/devguide``
+
+Core developers should use:
+
+``hg clone ssh://hg@hg.python.org/devguide``
+
+instead so that they can push back their edits to the server.
+
+To build the devguide, you must have `Sphinx`_ installed. The devguide html
+can be built by running:
+
+ make html
+
+in the checkout directory, which will write the files to the ``_build/html``
+directory.
+
.. _Sphinx: http://sphinx.pocoo.org/
diff --git a/index.rst b/index.rst
--- a/index.rst
+++ b/index.rst
@@ -150,9 +150,8 @@
Resources
---------
-* Anyone can clone this guide from http://hg.python.org/devguide/. Core
- developers should use ssh://hg@hg.python.org/devguide instead, so that they
- can push back their edits to the server.
+* Anyone can clone the sources for this guide. See
+ :ref:`helping-with-the-developers-guide`.
* Coding style guides
* :PEP:`7` (Style Guide for C Code)
* :PEP:`8` (Style Guide for Python Code)
--
Repository URL: http://hg.python.org/devguide
More information about the Python-checkins
mailing list