Tree [c6b02f] legacy-trunk / Doc /
History



File Date Author Commit
c-api 2008-08-26 Benjamin Peterson Benjamin Peterson [edd2ca] sort of backport 66038 by aliasing PyObject_Byt...
data 2007-12-02 Georg Brandl Georg Brandl [5781e1] Add documentation for PySys_* functions.
distutils 2008-05-11 Andrew M. Kuchling Andrew M. Kuchling [0df616] #1858: re-apply patch for this, adding the miss...
documenting 2008-04-19 Georg Brandl Georg Brandl [4f7180] :func: et al. should *not* include the parens.
extending 2008-08-28 Georg Brandl Georg Brandl [efc498] #3711: .dll isn't a valid Python extension anym...
howto 2008-04-18 Andrew M. Kuchling Andrew M. Kuchling [7cd363] #2654: fix typo
includes 2008-08-19 Jesse Noller Jesse Noller [7ea805] issue3352: clean up the multiprocessing API to ...
install 2008-03-15 Georg Brandl Georg Brandl [c07c5c] Fix lots of broken links in the docs, found by ...
library 2008-09-06 Andrew M. Kuchling Andrew M. Kuchling [445ce6] #1317: describe the does_esmtp, ehlo_resp, esmt...
reference 2008-08-31 Nick Coghlan Nick Coghlan [9c175f] Issue 2235: document the ability to block inher...
tools 2008-07-23 Georg Brandl Georg Brandl [8375b3] Move opcode handling to Python's extension.
tutorial 2008-08-08 Georg Brandl Georg Brandl [7224ff] Remove mention of backquotes in the tutorial.
using 2008-07-12 Benjamin Peterson Benjamin Peterson [38d3a5] fix various doc typos #3320
whatsnew 2008-09-06 Andrew M. Kuchling Andrew M. Kuchling [751f1b] Various corrections
ACKS.txt 2008-06-10 Georg Brandl Georg Brandl [ed572d] Add the "ast" module, containing helpers to eas...
Makefile 2008-06-26 Benjamin Peterson Benjamin Peterson [723c0f] add a htmlview directive
README.txt 2008-06-01 Georg Brandl Georg Brandl [c0d616] Generate pydoc's topic help from the reST docs ...
TODO.txt 2007-08-15 Georg Brandl Georg Brandl [c62f66] Move the 2.6 reST doc tree in place.
about.rst 2008-04-21 David Goodger David Goodger [f51953] capitalization
bugs.rst 2008-08-24 Benjamin Peterson Benjamin Peterson [58d295] remove note about unimplemented feature
conf.py 2008-06-17 Georg Brandl Georg Brandl [98d012] Split the HTML index.
contents.rst 2007-10-20 Georg Brandl Georg Brandl [252b9d] * Add new toplevel chapter, "Using Python." (ho...
copyright.rst 2008-03-02 Georg Brandl Georg Brandl [3439fa] Update year.
glossary.rst 2008-07-24 Benjamin Peterson Benjamin Peterson [1b1e1f] add some documentation for 2to3
license.rst 2008-05-08 Barry Warsaw Barry Warsaw [d4430e] Post tag updates.
make.bat 2008-04-13 Georg Brandl Georg Brandl [03d9c6] Check out Jinja as a separate step now that it'...

Read Me

Python Documentation README
~~~~~~~~~~~~~~~~~~~~~~~~~~~

This directory contains the reStructuredText (reST) sources to the Python
documentation.  You don't need to build them yourself, prebuilt versions are
available at http://docs.python.org/download/.

Documentation on the authoring Python documentation, including information about
both style and markup, is available in the "Documenting Python" chapter of the
documentation.  There's also a chapter intended to point out differences to
those familiar with the previous docs written in LaTeX.


Building the docs
=================

You need to install Python 2.4 or higher; the toolset used to build the docs are
written in Python.  The toolset used to build the documentation is called
*Sphinx*, it is not included in this tree, but maintained separately in the
Python Subversion repository.  Also needed are Jinja, a templating engine
(included in Sphinx as a Subversion external), and optionally Pygments, a code
highlighter.


Using make
----------

Luckily, a Makefile has been prepared so that on Unix, provided you have
installed Python and Subversion, you can just run ::

   make html

to check out the necessary toolset in the `tools/` subdirectory and build the
HTML output files.  To view the generated HTML, point your favorite browser at
the top-level index `build/html/index.html` after running "make".

Available make targets are:

 * "html", which builds standalone HTML files for offline viewing.

 * "web", which builds files usable with the Sphinx.web application (used to
   serve the docs online at http://docs.python.org/).

 * "htmlhelp", which builds HTML files and a HTML Help project file usable to
   convert them into a single Compiled HTML (.chm) file -- these are popular
   under Microsoft Windows, but very handy on every platform.

   To create the CHM file, you need to run the Microsoft HTML Help Workshop
   over the generated project (.hhp) file.

 * "latex", which builds LaTeX source files that can be run with "pdflatex"
   to produce PDF documents.

 * "text", which builds a plain text file for each source file.

 * "linkcheck", which checks all external references to see whether they are
   broken, redirected or malformed, and outputs this information to stdout
   as well as a plain-text (.txt) file.

 * "changes", which builds an overview over all versionadded/versionchanged/
   deprecated items in the current version. This is meant as a help for the
   writer of the "What's New" document.

 * "coverage", which builds a coverage overview for standard library modules
   and C API.

 * "pydoc-topics", which builds a Python module containing a dictionary
   with plain text documentation for the labels defined in
   `tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic
   and keyword help.

A "make update" updates the Subversion checkouts in `tools/`.


Without make
------------

You'll need to checkout the Sphinx package to the `tools/` directory::

   svn co http://svn.python.org/projects/doctools/trunk/sphinx tools/sphinx

Then, you need to install Docutils 0.4 (the SVN snapshot won't work), either
by checking it out via ::

   svn co http://svn.python.org/projects/external/docutils-0.4/docutils tools/docutils

or by installing it from http://docutils.sf.net/.

You can optionally also install Pygments, either as a checkout via :: 

   svn co http://svn.python.org/projects/external/Pygments-0.9/pygments tools/pygments

or from PyPI at http://pypi.python.org/pypi/Pygments.


Then, make an output directory, e.g. under `build/`, and run ::

   python tools/sphinx-build.py -b<builder> . build/<outputdirectory>

where `<builder>` is one of html, web or htmlhelp (for explanations see the make
targets above).


Contributing
============

For bugs in the content, the online version at http://docs.python.org/ has a
"suggest change" facility that can be used to correct errors in the source text
and submit them as a patch to the maintainers.

Bugs in the toolset should be reported in the Python bug tracker at
http://bugs.python.org/.

You can also send a mail to the Python Documentation Team at docs@python.org,
and we will process your request as soon as possible.

If you want to help the Documentation Team, you are always welcome.  Just send
a mail to docs@python.org.


Copyright notice
================

The Python source is copyrighted, but you can freely use and copy it
as long as you don't change or remove the copyright notice:

----------------------------------------------------------------------
Copyright (c) 2000-2008 Python Software Foundation.
All rights reserved.

Copyright (c) 2000 BeOpen.com.
All rights reserved.

Copyright (c) 1995-2000 Corporation for National Research Initiatives.
All rights reserved.

Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
All rights reserved.

See the file "license.rst" for information on usage and redistribution
of this file, and for a DISCLAIMER OF ALL WARRANTIES.
----------------------------------------------------------------------