Doc/README.txt

   1 Python Documentation README
   2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
   3
   4 This directory contains the reStructuredText (reST) sources to the Python
   5 documentation.  You don't need to build them yourself, prebuilt versions are
   6 available at http://docs.python.org/download/.
   7
   8 Documentation on the authoring Python documentation, including information about
   9 both style and markup, is available in the "Documenting Python" chapter of the
  10 documentation.  There's also a chapter intended to point out differences to
  11 those familiar with the previous docs written in LaTeX.
  12
  13
  14 Building the docs
  15 =================
  16
  17 You need to install Python 2.4 or higher (but Python 3.0 is not supported yet);
  18 the toolset used to build the docs are written in Python.  The toolset used
  19 to build the documentation is called *Sphinx*, it is not included in this
  20 tree, but maintained separately in the Python Subversion repository.  Also
  21 needed are Jinja, a templating engine (included in Sphinx as a Subversion
  22 external), and optionally Pygments, a code highlighter.
  23
  24
  25 Using make
  26 ----------
  27
  28 Luckily, a Makefile has been prepared so that on Unix, provided you have
  29 installed Python and Subversion, you can just run ::
  30
  31    make html
  32
  33 to check out the necessary toolset in the `tools/` subdirectory and build the
  34 HTML output files.  To view the generated HTML, point your favorite browser at
  35 the top-level index `build/html/index.html` after running "make".
  36
  37 To use a Python interpreter that's not called ``python``, use the standard
  38 way to set Makefile variables, using e.g. ::
  39
  40    make html PYTHON=/usr/bin/python2.5
  41
  42 Available make targets are:
  43
  44  * "html", which builds standalone HTML files for offline viewing.
  45
  46  * "web", which builds files usable with the Sphinx.web application (used to
  47    serve the docs online at http://docs.python.org/).
  48
  49  * "htmlhelp", which builds HTML files and a HTML Help project file usable to
  50    convert them into a single Compiled HTML (.chm) file -- these are popular
  51    under Microsoft Windows, but very handy on every platform.
  52
  53    To create the CHM file, you need to run the Microsoft HTML Help Workshop
  54    over the generated project (.hhp) file.
  55
  56  * "latex", which builds LaTeX source files that can be run with "pdflatex"
  57    to produce PDF documents.
  58
  59  * "text", which builds a plain text file for each source file.
  60
  61  * "linkcheck", which checks all external references to see whether they are
  62    broken, redirected or malformed, and outputs this information to stdout
  63    as well as a plain-text (.txt) file.
  64
  65  * "changes", which builds an overview over all versionadded/versionchanged/
  66    deprecated items in the current version. This is meant as a help for the
  67    writer of the "What's New" document.
  68
  69  * "coverage", which builds a coverage overview for standard library modules
  70    and C API.
  71
  72  * "pydoc-topics", which builds a Python module containing a dictionary
  73    with plain text documentation for the labels defined in
  74    `tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic
  75    and keyword help.
  76
  77 A "make update" updates the Subversion checkouts in `tools/`.
  78
  79
  80 Without make
  81 ------------
  82
  83 You'll need to checkout the Sphinx package to the `tools/` directory::
  84
  85    svn co http://svn.python.org/projects/doctools/trunk/sphinx tools/sphinx
  86
  87 Then, you need to install Docutils 0.4 (the SVN snapshot won't work), either
  88 by checking it out via ::
  89
  90    svn co http://svn.python.org/projects/external/docutils-0.4/docutils tools/docutils
  91
  92 or by installing it from http://docutils.sf.net/.
  93
  94 You can optionally also install Pygments, either as a checkout via ::
  95
  96    svn co http://svn.python.org/projects/external/Pygments-0.9/pygments tools/pygments
  97
  98 or from PyPI at http://pypi.python.org/pypi/Pygments.
  99
 100
 101 Then, make an output directory, e.g. under `build/`, and run ::
 102
 103    python tools/sphinx-build.py -b<builder> . build/<outputdirectory>
 104
 105 where `<builder>` is one of html, web or htmlhelp (for explanations see the make
 106 targets above).
 107
 108
 109 Contributing
 110 ============
 111
 112 For bugs in the content, the online version at http://docs.python.org/ has a
 113 "suggest change" facility that can be used to correct errors in the source text
 114 and submit them as a patch to the maintainers.
 115
 116 Bugs in the toolset should be reported in the Python bug tracker at
 117 http://bugs.python.org/.
 118
 119 You can also send a mail to the Python Documentation Team at docs@python.org,
 120 and we will process your request as soon as possible.
 121
 122 If you want to help the Documentation Team, you are always welcome.  Just send
 123 a mail to docs@python.org.
 124
 125
 126 Copyright notice
 127 ================
 128
 129 The Python source is copyrighted, but you can freely use and copy it
 130 as long as you don't change or remove the copyright notice:
 131
 132 ----------------------------------------------------------------------
 133 Copyright (c) 2000-2008 Python Software Foundation.
 134 All rights reserved.
 135
 136 Copyright (c) 2000 BeOpen.com.
 137 All rights reserved.
 138
 139 Copyright (c) 1995-2000 Corporation for National Research Initiatives.
 140 All rights reserved.
 141
 142 Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
 143 All rights reserved.
 144
 145 See the file "license.rst" for information on usage and redistribution
 146 of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 147 ----------------------------------------------------------------------