@@ -3,34 +3,31 @@ Python Documentation README
33
44This directory contains the reStructuredText (reST) sources to the Python
55documentation. You don't need to build them yourself, prebuilt versions are
6- available at http://docs.python.org/download/.
6+ available at < http://docs.python.org/download/> .
77
88Documentation on the authoring Python documentation, including information about
99both style and markup, is available in the "Documenting Python" chapter of the
10- documentation .
10+ developers guide <http://docs.python.org/devguide/documenting.html> .
1111
1212
1313Building the docs
1414=================
1515
16- You need to have Python 2 installed; the toolset used to build the
17- docs is written in Python. It is called *Sphinx*, it is not included in this
18- tree, but maintained separately. Also needed are the docutils, supplying the
19- base markup that Sphinx uses, Jinja, a templating engine, and optionally
20- Pygments, a code highlighter.
16+ You need to have Sphinx <http://sphinx-doc.org/> installed; it is the toolset
17+ used to build the docs. It is not included in this tree, but maintained
18+ separately and available from PyPI <http://pypi.python.org/pypi/Sphinx>.
2119
2220
2321Using make
2422----------
2523
26- Luckily, a Makefile has been prepared so that on Unix, provided you have
27- installed Python and Subversion , you can just run ::
24+ A Makefile has been prepared so that on Unix, provided you have installed
25+ Sphinx , you can just run ::
2826
2927 make html
3028
31- to check out the necessary toolset in the `tools/` subdirectory and build the
32- HTML output files. To view the generated HTML, point your favorite browser at
33- the top-level index `build/html/index.html` after running "make".
29+ to build the HTML output files. To view the generated HTML, point your favorite
30+ browser at the top-level index `build/html/index.html` after running "make".
3431
3532On Windows, we try to emulate the Makefile as closely as possible with a
3633``make.bat`` file.
@@ -78,8 +75,6 @@ Available make targets are:
7875 * "suspicious", which checks the parsed markup for text that looks like
7976 malformed and thus unconverted reST.
8077
81- A "make update" updates the Subversion checkouts in `tools/`.
82-
8378
8479Without make
8580------------
0 commit comments