cpython/Doc
Andrew M. Kuchling 3e75d2336d Add e-mail address 2008-09-02 13:08:11 +00:00
..
c-api sort of backport 66038 by aliasing PyObject_Bytes to PyObject_Str 2008-08-26 17:08:40 +00:00
data Add documentation for PySys_* functions. 2007-12-02 21:58:54 +00:00
distutils #1858: re-apply patch for this, adding the missing files 2008-05-11 14:00:00 +00:00
documenting :func: et al. should *not* include the parens. 2008-04-19 17:00:14 +00:00
extending #3711: .dll isn't a valid Python extension anymore. 2008-08-28 09:40:18 +00:00
howto #2654: fix typo 2008-04-18 16:53:09 +00:00
includes issue3352: clean up the multiprocessing API to remove many get_/set_ methods and convert them to properties. Update the docs and the examples included. 2008-08-19 19:06:19 +00:00
install Fix lots of broken links in the docs, found by Sphinx' external link checker. 2008-03-15 00:20:19 +00:00
library typo fix 2008-09-02 01:39:18 +00:00
reference Issue 2235: document the ability to block inheritance of __hash__ in the language reference 2008-08-31 13:10:50 +00:00
tools Move opcode handling to Python's extension. 2008-07-23 15:17:09 +00:00
tutorial Remove mention of backquotes in the tutorial. 2008-08-08 15:34:34 +00:00
using fix various doc typos #3320 2008-07-12 20:16:19 +00:00
whatsnew Add e-mail address 2008-09-02 13:08:11 +00:00
ACKS.txt Add the "ast" module, containing helpers to ease use of the "_ast" classes. 2008-06-10 07:45:28 +00:00
Makefile add a htmlview directive 2008-06-26 21:23:30 +00:00
README.txt Generate pydoc's topic help from the reST docs via Sphinx' 2008-06-01 20:33:55 +00:00
TODO.txt Move the 2.6 reST doc tree in place. 2007-08-15 14:28:01 +00:00
about.rst capitalization 2008-04-21 14:43:33 +00:00
bugs.rst remove note about unimplemented feature 2008-08-24 21:55:03 +00:00
conf.py Split the HTML index. 2008-06-17 09:01:35 +00:00
contents.rst * Add new toplevel chapter, "Using Python." (how to install, 2007-10-20 18:08:14 +00:00
copyright.rst Update year. 2008-03-02 06:32:32 +00:00
glossary.rst add some documentation for 2to3 2008-07-24 02:45:37 +00:00
license.rst Post tag updates. 2008-05-08 15:30:00 +00:00
make.bat Check out Jinja as a separate step now that it's not included in the Sphinx package anymore. 2008-04-13 20:51:27 +00:00

README.txt

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.
----------------------------------------------------------------------