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