Permalink
..
Failed to load latest commit information.
c-api bpo-33892: Doc: Use gender neutral words (GH-7770) Jun 18, 2018
data Add missed details of the C API introduced in 3.7. (GH-7047) May 22, 2018
distributing bpo-33503: Fix the broken pypi link in the source and the documentati… May 15, 2018
distutils bpo-33892: Doc: Use gender neutral words (GH-7770) Jun 18, 2018
extending bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413) Jun 14, 2018
faq bpo-33888: Use CPython instead of Python in the FAQ (GH-7767) Jul 7, 2018
howto bpo-34083: Update dict order in Functional HOWTO (GH-8230) Jul 11, 2018
includes Removed unused import from tzinfo_examples.py. (GH-7994) Jul 5, 2018
install Improve highlighting of some code blocks. (GH-6401) Apr 8, 2018
installing bpo-33503: Fix the broken pypi link in the source and the documentati… May 15, 2018
library Clarify ValueError's broad applicability (GH-8313) Jul 17, 2018
reference bpo-33702: Add some missing links in production lists and do a little… Jul 7, 2018
tools Forward port 3.7.0 final changes Jun 27, 2018
tutorial Fix documentation for input and output tutorial (GH-8231) Jul 11, 2018
using bpo-30660: Doc: Optimize PNG files by optipng (GH-8032) Jul 1, 2018
whatsnew bpo-32430: Rename Modules/Setup.dist to Modules/Setup (GH-8229) Jul 16, 2018
Makefile bpo-30607: Use external python-doc-theme (GH-2017) Mar 1, 2018
README.rst bpo-30607: Use external python-doc-theme (GH-2017) Mar 1, 2018
about.rst Fixing broken links in doc, part 4: some more breaks and redirects Oct 29, 2014
bugs.rst bpo-25910: Fixes redirection from http to https (#4674) Dec 6, 2017
conf.py bpo-30607: Use external python-doc-theme (GH-2017) Mar 1, 2018
contents.rst Doc/contents: avoid false positive in rstlint Oct 30, 2014
copyright.rst advance copyright years to 2018 (#5094) Jan 5, 2018
docutils.conf bpo-31793: Doc: Specialize smart-quotes for Japanese (GH-4006) Nov 7, 2017
glossary.rst bpo-33571: Improve the glossary description for '...' prompt (GH-6971) Jun 16, 2018
license.rst bpo-29137: Remove fpectl module (#4789) Jan 6, 2018
make.bat bpo-34006: Revert line length limit for Windows help docs (GH-8051) Jul 2, 2018

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.

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

Building the docs

The documentation is built with several tools which are not included in this tree but are maintained separately and are available from PyPI.

The easiest way to install these tools is to create a virtual environment and install the tools into there.

Using make

To get started on UNIX, you can create a virtual environment with the command

make venv

That will install all the tools necessary to build the documentation. Assuming the virtual environment was created in the env directory (the default; configurable with the VENVDIR variable), you can run the following command to build the HTML output files:

make html

By default, if the virtual environment is not created, the Makefile will look for instances of sphinxbuild and blurb installed on your process PATH (configurable with the SPHINXBUILD and BLURB variables).

On Windows, we try to emulate the Makefile as closely as possible with a make.bat file. If you need to specify the Python interpreter to use, set the PYTHON environment variable instead.

Available make targets are:

  • "clean", which removes all build files.

  • "venv", which creates a virtual environment with all necessary tools installed.

  • "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

First, install the tool 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.

Bugs in the toolset should be reported to the tools themselves.

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.