cpython/Doc
Jesus Cea 6d52ced4ce Closes #20872: dbm/gdbm/ndbm close methods are not documented 2014-06-25 12:55:48 +02:00
..
c-api Issue #17145: Document array.array buffer interface limitations. 2014-04-26 22:50:25 +02:00
data Issue #18085: Fix PyObject_CallMethodObjArgs()'s entry in refcounts.dat. 2013-05-28 22:46:51 +03:00
distutils Issue #21726: Remove unnecessary and contextually wrong line. 2014-06-13 14:57:44 -04:00
extending Issue #19407: add Python Packaging User Guide notes 2013-12-10 21:18:32 +10:00
faq Closes #21759: URL Typo in Documentation FAQ 2014-06-16 14:11:14 +02:00
howto Fixed typo in documentation. 2014-06-25 07:29:19 +01:00
includes Issue #16341: convert examples to use except ... as ... syntax. 2012-10-30 21:56:43 +02:00
install Make distutils error messages more helpful (#11599). 2014-03-12 22:19:39 -04:00
library Closes #20872: dbm/gdbm/ndbm close methods are not documented 2014-06-25 12:55:48 +02:00
reference remove confusing delete indexing (closes #21466) 2014-05-11 11:18:51 -07:00
tools Update references to Python docs in the sidebar index. 2014-06-02 22:57:07 -07:00
tutorial Issue #11974: Add tutorial section on class and instance variables 2014-06-23 18:03:21 -07:00
using remove list of example incompatibilities (closes #21434) 2014-05-26 15:38:52 -07:00
whatsnew Updates to Python 2.7 What's New preamble 2014-06-07 23:36:13 +10:00
Makefile allow doc archives to be built for versions in the rc stage 2014-05-24 15:15:26 -07:00
README.txt issue #21190: Fix the docs README link 2014-04-09 11:41:02 -04:00
about.rst Issue #20255: Update the about and bugs pages. 2014-01-14 16:01:32 -06:00
bugs.rst Issue #20255: Update the about and bugs pages. 2014-01-14 16:01:32 -06:00
conf.py Determine opensearch URL from current version. 2012-04-07 19:24:40 +02:00
contents.rst Remove packaging from the standard library. 2012-06-24 00:07:41 -04:00
copyright.rst update copyright year 2013-12-31 22:02:22 -06:00
glossary.rst Issue #19190: Improve cross-references in builtin types and functions documentation. 2013-10-09 14:02:14 +03:00
license.rst update copyright year 2013-12-31 22:02:22 -06:00
make.bat Issue #17412: update 2.7 Doc/make.bat to also use sphinx-1.0.7. 2013-03-14 19:32:22 -04: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 https://docs.python.org/2/download.html

Documentation on the authoring Python documentation, including information about
both style and markup, is available in the "Documenting Python" chapter of the
documentation.


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

You need to have Python 2 installed; the toolset used to build the
docs is written in Python.  It is called *Sphinx*, it is not included in this
tree, but maintained separately.  Also needed are the docutils, supplying the
base markup that Sphinx uses, Jinja, a templating engine, 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".

On Windows, we try to emulate the Makefile as closely as possible with a
``make.bat`` file.

Available make targets are:

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

 * "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 as input to "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.

 * "suspicious", which checks the parsed markup for text that looks like
   malformed and thus unconverted reST.

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


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

Install the Sphinx package and its dependencies from PyPI.

Then, from the ``Docs`` directory, run ::

   sphinx-build -b<builder> . build/<builder>

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


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

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

Bugs in the toolset should be reported in the Sphinx bug tracker at
http://www.bitbucket.org/birkenfeld/sphinx/issues/.

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