Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Update README.

This commit is contained in:
Georg Brandl 2010-06-12 09:46:03 +00:00
parent 961e6fd37a
commit f084aed3b0
1 changed files with 18 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
Doc/README.txt
View File

@ -14,12 +14,11 @@ those familiar with the previous docs written in LaTeX.
Building the docs Building the docs
================= =================
You need to install Python 2.4 or higher; the toolset used to build the docs are You need to have Python 2.4 or higher installed; the toolset used to build the
written in Python. The toolset used to build the documentation is called docs is written in Python. It is called *Sphinx*, it is not included in this
*Sphinx*, it is not included in this tree, but maintained separately in the tree, but maintained separately. Also needed are the docutils, supplying the
Python Subversion repository. Also needed are Jinja, a templating engine base markup that Sphinx uses, Jinja, a templating engine, and optionally
(included in Sphinx as a Subversion external), and optionally Pygments, a code Pygments, a code highlighter.
highlighter.
Using make Using make
@ -42,29 +41,29 @@ Available make targets are:
convert them into a single Compiled HTML (.chm) file -- these are popular convert them into a single Compiled HTML (.chm) file -- these are popular
under Microsoft Windows, but very handy on every platform. under Microsoft Windows, but very handy on every platform.
To create the CHM file, you need to run the Microsoft HTML Help Workshop To create the CHM file, you need to run the Microsoft HTML Help Workshop over
over the generated project (.hhp) file. the generated project (.hhp) file.
* "latex", which builds LaTeX source files that can be run with "pdflatex" * "latex", which builds LaTeX source files as input to "pdflatex" to produce
to produce PDF documents. PDF documents.
* "text", which builds a plain text file for each source file. * "text", which builds a plain text file for each source file.
* "linkcheck", which checks all external references to see whether they are * "linkcheck", which checks all external references to see whether they are
broken, redirected or malformed, and outputs this information to stdout broken, redirected or malformed, and outputs this information to stdout as
as well as a plain-text (.txt) file. well as a plain-text (.txt) file.
* "changes", which builds an overview over all versionadded/versionchanged/ * "changes", which builds an overview over all versionadded/versionchanged/
deprecated items in the current version. This is meant as a help for the deprecated items in the current version. This is meant as a help for the
writer of the "What's New" document. writer of the "What's New" document.
* "coverage", which builds a coverage overview for standard library modules * "coverage", which builds a coverage overview for standard library modules and
and C API. C API.
* "pydoc-topics", which builds a Python module containing a dictionary * "pydoc-topics", which builds a Python module containing a dictionary with
with plain text documentation for the labels defined in plain text documentation for the labels defined in
`tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic `tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic and
and keyword help. keyword help.
A "make update" updates the Subversion checkouts in `tools/`. A "make update" updates the Subversion checkouts in `tools/`.
@ -90,7 +89,7 @@ You also need Jinja2, either by checking it out via ::
or by installing it from PyPI. or by installing it from PyPI.
You can optionally also install Pygments, either as a checkout via :: You can optionally also install Pygments, either as a checkout via ::
svn co http://svn.python.org/projects/external/Pygments-1.3.1/pygments tools/pygments svn co http://svn.python.org/projects/external/Pygments-1.3.1/pygments tools/pygments