17
You need to install Python 2.4 or higher; the toolset used to build the docs are
18
written in Python. The toolset used to build the documentation is called
19
*Sphinx*, it is not included in this tree, but maintained separately in the
20
Python Subversion repository. Also needed are Jinja, a templating engine
21
(included in Sphinx as a Subversion external), and optionally Pygments, a code
17
You need to have Python 2.4 or higher installed; the toolset used to build the
18
docs is written in Python. It is called *Sphinx*, it is not included in this
19
tree, but maintained separately. Also needed are the docutils, supplying the
20
base markup that Sphinx uses, Jinja, a templating engine, and optionally
21
Pygments, a code highlighter.
42
41
convert them into a single Compiled HTML (.chm) file -- these are popular
43
42
under Microsoft Windows, but very handy on every platform.
45
To create the CHM file, you need to run the Microsoft HTML Help Workshop
46
over the generated project (.hhp) file.
44
To create the CHM file, you need to run the Microsoft HTML Help Workshop over
45
the generated project (.hhp) file.
48
* "latex", which builds LaTeX source files that can be run with "pdflatex"
49
to produce PDF documents.
47
* "latex", which builds LaTeX source files as input to "pdflatex" to produce
51
50
* "text", which builds a plain text file for each source file.
53
52
* "linkcheck", which checks all external references to see whether they are
54
broken, redirected or malformed, and outputs this information to stdout
55
as well as a plain-text (.txt) file.
53
broken, redirected or malformed, and outputs this information to stdout as
54
well as a plain-text (.txt) file.
57
56
* "changes", which builds an overview over all versionadded/versionchanged/
58
57
deprecated items in the current version. This is meant as a help for the
59
58
writer of the "What's New" document.
61
* "coverage", which builds a coverage overview for standard library modules
60
* "coverage", which builds a coverage overview for standard library modules and
64
* "pydoc-topics", which builds a Python module containing a dictionary
65
with plain text documentation for the labels defined in
66
`tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic
63
* "pydoc-topics", which builds a Python module containing a dictionary with
64
plain text documentation for the labels defined in
65
`tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic and
69
68
A "make update" updates the Subversion checkouts in `tools/`.
91
90
or by installing it from PyPI.
93
You can optionally also install Pygments, either as a checkout via ::
92
You can optionally also install Pygments, either as a checkout via ::
95
94
svn co http://svn.python.org/projects/external/Pygments-1.3.1/pygments tools/pygments
added
removed
Doc/README.txt
