Tree [a32ced] default / Doc /
 History

Read Only access


File Date Author Commit
 c-api 2007-11-02 Guido van Rossum Guido van Rossum [317ba5] Merged revisions 58742-58816 via svnmerge from
 data 2007-10-19 Guido van Rossum Guido van Rossum [a2bb76] Patch 1267 by Christian Heimes.
 distributing 2014-06-05 Zachary Ware Zachary Ware [a70884] Issue #21661: Fix typo.
 distutils 2007-11-01 Georg Brandl Georg Brandl [3d8665] #1370: Finish the merge r58749, log below, by r...
 extending 2007-11-01 Georg Brandl Georg Brandl [3d8665] #1370: Finish the merge r58749, log below, by r...
 faq unknown
 howto 2007-11-01 Georg Brandl Georg Brandl [2b7aad] Remove file that should have been removed durin...
 includes 2007-11-01 Georg Brandl Georg Brandl [3d8665] #1370: Finish the merge r58749, log below, by r...
 install 2007-09-01 Georg Brandl Georg Brandl [808f32] Get rid of the remaining versionadded/versionch...
 installing unknown
 library 2014-06-05 Victor Stinner Victor Stinner [4b51a9] Issue #21515: tempfile.TemporaryFile now uses o...
 reference 2014-06-05 R David Murray R David Murray [3aa21b] Merge #21662: fix typo, improve sentence flow
 tools 2007-08-31 Georg Brandl Georg Brandl [221ffa] Fix sphinx-build so that it runs with 2.x and 3...
 tutorial 2007-11-01 Georg Brandl Georg Brandl [3d8665] #1370: Finish the merge r58749, log below, by r...
 using 2007-11-01 Georg Brandl Georg Brandl [c00dc7] Add new directory "using". This should have bee...
 whatsnew 2007-11-06 Guido van Rossum Guido van Rossum [0d462d] Merging the py3k-pep3137 branch back into the p...
 Makefile 2007-10-23 Georg Brandl Georg Brandl [634c3d] Update Pygments version from externals.
 README.txt 2007-11-01 Georg Brandl Georg Brandl [3d8665] #1370: Finish the merge r58749, log below, by r...
 about.rst 2007-08-15 Georg Brandl Georg Brandl [9e1529] Move the 3k reST doc tree in place.
 bugs.rst 2007-08-15 Georg Brandl Georg Brandl [9e1529] Move the 3k reST doc tree in place.
 conf.py 2007-08-15 Georg Brandl Georg Brandl [9e1529] Move the 3k reST doc tree in place.
 contents.rst 2007-11-01 Georg Brandl Georg Brandl [3d8665] #1370: Finish the merge r58749, log below, by r...
 copyright.rst 2007-08-15 Georg Brandl Georg Brandl [9e1529] Move the 3k reST doc tree in place.
 glossary.rst 2007-11-02 Guido van Rossum Guido van Rossum [317ba5] Merged revisions 58742-58816 via svnmerge from
 license.rst 2007-08-30 Georg Brandl Georg Brandl [504c15] Add 3.0 to the silly list in license.rst too, a...
 make.bat unknown

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 <https://docs.python.org/dev/download.html>.

Documentation on authoring Python documentation, including information about
both style and markup, is available in the "Documenting Python" chapter of the
developers guide <http://docs.python.org/devguide/documenting.html>.


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

You need to have Sphinx <http://sphinx-doc.org/> installed; it is the toolset
used to build the docs.  It is not included in this tree, but maintained
separately and available from PyPI <http://pypi.python.org/pypi/Sphinx>.


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

A Makefile has been prepared so that on Unix, provided you have installed
Sphinx, you can just run ::

   make html

to build the HTML output files.

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

To use a Python interpreter that's not called ``python``, use the standard
way to set Makefile variables, using e.g. ::

   make html PYTHON=python3

On Windows, set the PYTHON environment variable instead.

To use a specific sphinx-build (something other than ``sphinx-build``), set
the SPHINXBUILD variable.

Available make targets are:

 * "clean", which removes all build files.

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

 * "htmlview", which re-uses the "html" builder, but then opens the main page
   in your default web browser.

 * "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.  The make.bat script does this for
   you on Windows.

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

 * "epub", which builds an EPUB document, suitable to be viewed on e-book
   readers.

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

 * "check", which checks for frequent markup errors.

 * "serve", which serves the build/html directory on port 8000.

 * "dist", (Unix only) which creates distributable archives of HTML, text,
   PDF, and EPUB builds.


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

Install the Sphinx package and its dependencies from PyPI.

Then, from the ``Doc`` 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.
----------------------------------------------------------------------