cpython/Doc
Walter Dörwald f5c58c781a bpo-30733: Fix typos in "What's New" entry (GH-2414) 2017-06-26 18:31:52 +02:00
..
c-api bpo-30054: Expose tracemalloc C API (#1236) 2017-06-20 17:46:36 +02:00
data Mark PyDict_GetItemWithError() as returning a borrowed reference. (#1818) 2017-06-01 12:29:13 -06:00
distributing Issue #26014: Update 3.x packaging documentation: 2016-06-05 17:38:48 -07:00
distutils bpo-11913: Add README.rst to the distutils standard READMEs list (#563) 2017-04-14 11:00:25 +02:00
extending bpo-28315: Improve code examples in docs (GH-1372) 2017-05-03 09:46:45 -07:00
faq bpo-27200: Fix doctests in programming.rst and datetime.rst (#401) 2017-03-18 19:59:33 +03:00
howto bpo-30709: Improve code example in Descriptor HowTo doc (GH-2339) 2017-06-22 20:54:35 -07:00
includes bpo-27200: Fix doctests in programming.rst and datetime.rst (#401) 2017-03-18 19:59:33 +03:00
install Issue #26638: Mask undefined CLI options to defeat new Sphinx warnings 2016-10-30 04:20:17 +00:00
installing Issue #27285: Document the deprecation of the pyvenv script. 2016-07-08 10:46:21 -07:00
library Fix bpo-30596: Add close() method to multiprocessing.Process (#2010) 2017-06-24 19:22:23 +02:00
reference bpo-30736: upgrade to Unicode 10.0 (#2344) 2017-06-22 22:31:08 -07:00
tools bpo-29783: Replace codecs.open() with io.open() (#599) 2017-06-16 08:59:01 +02:00
tutorial bpo-6519: Improve Python Input Output Tutorial (GH-2143) 2017-06-12 22:31:01 -07:00
using bpo-30565: Add PYTHONCOERCECLOCALE=warn runtime flag (GH-2260) 2017-06-18 12:29:42 +10:00
whatsnew bpo-30733: Fix typos in "What's New" entry (GH-2414) 2017-06-26 18:31:52 +02:00
Makefile bpo-30052: Always regenerate cross-references (#1339) 2017-06-02 23:30:57 +10:00
README.rst Rename Doc/README.txt to Doc/README.rst and add formatting (#104) 2017-02-15 23:54:05 +01:00
about.rst
bugs.rst Issue #17888: Add a note about contributing to Python docs 2016-06-04 21:47:44 -07:00
conf.py bpo-27200: Fix doctests in programming.rst and datetime.rst (#401) 2017-03-18 19:59:33 +03:00
contents.rst
copyright.rst 2016 will be another year of writing copyrighted code 2016-01-01 10:23:45 -06:00
glossary.rst bpo-26947: DOC: clarify wording on hashable in glossary (#948) 2017-04-01 19:50:47 -07:00
license.rst Minor grammar fixes (GH-1174) 2017-04-18 18:59:47 -07:00
make.bat Show what's changed when Travis fails regen check (GH-2095) 2017-06-10 23:04:36 -05:00

README.rst

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 <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
<https://docs.python.org/devguide/documenting.html>`_" chapter of the
developers guide.


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 <https://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/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 <https://bugs.python.org>`_.

Bugs in the toolset should be reported in the 
`Sphinx bug tracker <https://github.com/sphinx-doc/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.