README.txt 4.65 KB
Newer Older
1 2 3 4 5
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
6
available at <https://docs.python.org/3.4/download.html>.
7

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


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

16 17 18
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>.
19 20 21 22 23


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

24 25
A Makefile has been prepared so that on Unix, provided you have installed
Sphinx, you can just run ::
26 27 28

   make html

29
to build the HTML output files.
30

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

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

37 38 39 40 41 42
   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.
43

44 45
Available make targets are:

46 47
 * "clean", which removes all build files.

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

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

53 54 55 56
 * "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.

57 58 59
   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.
60

Benjamin Peterson's avatar
Benjamin Peterson committed
61 62
 * "latex", which builds LaTeX source files as input to "pdflatex" to produce
   PDF documents.
Christian Heimes's avatar
Christian Heimes committed
63

Georg Brandl's avatar
Georg Brandl committed
64 65
 * "text", which builds a plain text file for each source file.

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

Christian Heimes's avatar
Christian Heimes committed
69
 * "linkcheck", which checks all external references to see whether they are
Benjamin Peterson's avatar
Benjamin Peterson committed
70 71
   broken, redirected or malformed, and outputs this information to stdout as
   well as a plain-text (.txt) file.
72

73 74 75 76
 * "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.

Benjamin Peterson's avatar
Benjamin Peterson committed
77 78
 * "coverage", which builds a coverage overview for standard library modules and
   C API.
79

Benjamin Peterson's avatar
Benjamin Peterson committed
80 81 82 83
 * "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.
84

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

88 89 90 91 92 93 94
 * "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.

95 96 97 98

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

99
Install the Sphinx package and its dependencies from PyPI.
100

101
Then, from the ``Doc`` directory, run ::
102

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

105 106
where ``<builder>`` is one of html, text, latex, or htmlhelp (for explanations
see the make targets above).
107 108 109 110 111


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

Benjamin Peterson's avatar
Benjamin Peterson committed
112 113
Bugs in the content should be reported to the Python bug tracker at
http://bugs.python.org.
114

Benjamin Peterson's avatar
Benjamin Peterson committed
115 116
Bugs in the toolset should be reported in the Sphinx bug tracker at
http://www.bitbucket.org/birkenfeld/sphinx/issues/.
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131

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:

----------------------------------------------------------------------
132
Copyright (c) 2000-2014 Python Software Foundation.
133 134 135 136 137 138 139 140 141 142 143 144 145 146
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.
----------------------------------------------------------------------