[Python-checkins] devguide: Issue #12415: describe where the documentation files are (patch by Éric Araujo)

Tue Aug 21 00:02:19 CEST 2012

http://hg.python.org/devguide/rev/e0d68c73e351
changeset: 540:e0d68c73e351
user: Sandro Tosi <sandro.tosi at gmail.com>
date: Tue Aug 21 00:01:53 2012 +0200
summary:
 Issue #12415: describe where the documentation files are (patch by Éric Araujo)
files:
 documenting.rst | 13 ++++++++++---
 setup.rst | 4 +++-
 2 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/documenting.rst b/documenting.rst
--- a/documenting.rst
+++ b/documenting.rst
@@ -12,6 +12,10 @@
 custom reStructuredText markup introduced by Sphinx to support Python
 documentation and how it should be used.
 
+The documentation in HTML, PDF or EPUB format is generated from text files
+written using the :ref:`reStructuredText format <markup>` and contained in the
+:ref:`CPython Mercurial repository <setup>`.
+
 .. _reStructuredText: http://docutils.sf.net/rst.html
 .. _docutils: http://docutils.sf.net/
 .. _Sphinx: http://sphinx.pocoo.org/
@@ -1623,6 +1627,7 @@
 
 .. XXX more (index-generating, production lists, ...)
 
+.. _building-doc:
 
 Building the documentation
 ==========================
@@ -1638,7 +1643,8 @@
 ----------
 
 Luckily, a Makefile has been prepared so that on Unix, provided you have
-installed Python and Subversion, you can just run ::
+installed Python and Subversion, you can just go to your :ref:`clone of the
+CPython Mercurial repository <setup>` and run ::
 
 cd Doc
 make html
@@ -1679,7 +1685,8 @@
 :file:`tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic and
 keyword help.
 
-A "make update" updates the Subversion checkouts in :file:`tools/`.
+A "make update" updates the Subversion checkouts in :file:`tools/`. (These
+Subversion checkouts are ignored by the main Mercurial repository.)
 
 
 Without make
@@ -1687,7 +1694,7 @@
 
 You'll need to install the Sphinx package, either by checking it out via ::
 
- svn co http://svn.python.org/projects/external/Sphinx-0.6.5/sphinx tools/sphinx
+ svn co http://svn.python.org/projects/external/Sphinx-1.0.7/sphinx tools/sphinx
 
 or by installing it from PyPI.
 
diff --git a/setup.rst b/setup.rst
--- a/setup.rst
+++ b/setup.rst
@@ -54,6 +54,8 @@
 use and testing. (If you change C code, you will need to recompile the
 affected files as described below.)
 
+Patches for the documentation can be made from the same repository; see
+:ref:`documenting`.
 
 .. _compiling:
 
@@ -232,7 +234,7 @@
 
 ``Doc``
 The official documentation. This is what http://docs.python.org/ uses.
- To build the docs, see ``Doc/README.txt``.
+ See also :ref:`building-doc`.
 
 ``Grammar``
 Contains the :abbr:`EBNF (Extended Backus-Naur Form)` grammar file for
-- 
Repository URL: http://hg.python.org/devguide
