diff --git a/documenting.rst b/documenting.rst --- a/documenting.rst +++ b/documenting.rst @@ -12,6 +12,9 @@ This document describes the style guide custom reStructuredText markup introduced by Sphinx to support Python documentation and how it should be used. +The documentation sources are part of the main :ref:`CPython Mercurial +repository `. + .. _reStructuredText: http://docutils.sf.net/rst.html .. _docutils: http://docutils.sf.net/ .. _Sphinx: http://sphinx.pocoo.org/ @@ -1620,6 +1623,7 @@ directories renamed as follows: .. XXX more (index-generating, production lists, ...) +.. _building-doc: Building the documentation ========================== @@ -1635,7 +1639,8 @@ Using make ---------- 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 ` and run :: cd Doc make html @@ -1676,7 +1681,8 @@ Available make targets are: :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 @@ -1684,7 +1690,7 @@ Without make 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 @@ changes to Python code will be picked up 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: @@ -199,7 +201,7 @@ every rule. ``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