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  * "htmlhelp", which builds HTML files and a HTML Help project file usable to
  47    convert them into a single Compiled HTML (.chm) file -- these are popular
  48    under Microsoft Windows, but very handy on every platform.
  49
  50    To create the CHM file, you need to run the Microsoft HTML Help Workshop
  51    over the generated project (.hhp) file.
  52
  53  * "latex", which builds LaTeX source files that can be run with "pdflatex"
  54    to produce PDF documents.
  55
  56  * "text", which builds a plain text file for each source file.
  57
  58  * "linkcheck", which checks all external references to see whether they are
  59    broken, redirected or malformed, and outputs this information to stdout
  60    as well as a plain-text (.txt) file.
  61
  62  * "changes", which builds an overview over all versionadded/versionchanged/
  63    deprecated items in the current version. This is meant as a help for the
  64    writer of the "What's New" document.
  65
  66  * "coverage", which builds a coverage overview for standard library modules
  67    and C API.
  68
  69  * "pydoc-topics", which builds a Python module containing a dictionary
  70    with plain text documentation for the labels defined in
  71    `tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic
  72    and keyword help.
  73
  74 A "make update" updates the Subversion checkouts in `tools/`.
  75
  76
  77 Without make
  78 ------------
  79
  80 You'll need to install the Sphinx package, either by checking it out via ::
  81
  82    svn co http://svn.python.org/projects/external/Sphinx-0.6.5/sphinx tools/sphinx
  83
  84 or by installing it from PyPI.
  85
  86 Then, you need to install Docutils, either by checking it out via ::
  87
  88    svn co http://svn.python.org/projects/external/docutils-0.6/docutils tools/docutils
  89
  90 or by installing it from http://docutils.sf.net/.
  91
  92 You also need Jinja2, either by checking it out via ::
  93
  94    svn co http://svn.python.org/projects/external/Jinja-2.3.1/jinja2 tools/jinja2
  95
  96 or by installing it from PyPI.
  97
  98 You can optionally also install Pygments, either as a checkout via ::
  99
 100    svn co http://svn.python.org/projects/external/Pygments-1.3.1/pygments tools/pygments
 101
 102 or from PyPI at http://pypi.python.org/pypi/Pygments.
 103
 104
 105 Then, make an output directory, e.g. under `build/`, and run ::
 106
 107    python tools/sphinx-build.py -b<builder> . build/<outputdirectory>
 108
 109 where `<builder>` is one of html, text, latex, or htmlhelp (for explanations see
 110 the make targets above).
 111
 112
 113 Contributing
 114 ============
 115
 116 Bugs in the content should be reported to the Python bug tracker at
 117 http://bugs.python.org.
 118
 119 Bugs in the toolset should be reported in the Sphinx bug tracker at
 120 http://www.bitbucket.org/birkenfeld/sphinx/issues/.
 121
 122 You can also send a mail to the Python Documentation Team at docs@python.org,
 123 and we will process your request as soon as possible.
 124
 125 If you want to help the Documentation Team, you are always welcome.  Just send
 126 a mail to docs@python.org.
 127
 128
 129 Copyright notice
 130 ================
 131
 132 The Python source is copyrighted, but you can freely use and copy it
 133 as long as you don't change or remove the copyright notice:
 134
 135 ----------------------------------------------------------------------
 136 Copyright (c) 2000-2008 Python Software Foundation.
 137 All rights reserved.
 138
 139 Copyright (c) 2000 BeOpen.com.
 140 All rights reserved.
 141
 142 Copyright (c) 1995-2000 Corporation for National Research Initiatives.
 143 All rights reserved.
 144
 145 Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
 146 All rights reserved.
 147
 148 See the file "license.rst" for information on usage and redistribution
 149 of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 150 ----------------------------------------------------------------------