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.5 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  * "changes", which builds an overview over all versionadded/versionchanged/
  55    deprecated items in the current version. This is meant as a help for the
  56    writer of the "What's New" document.
  57
  58 A "make update" updates the Subversion checkouts in `tools/`.
  59
  60
  61 Without make
  62 ------------
  63
  64 You'll need to checkout the Sphinx package to the `tools/` directory::
  65
  66    svn co http://svn.python.org/projects/doctools/trunk/sphinx tools/sphinx
  67
  68 Then, you need to install Docutils 0.4 (the SVN snapshot won't work), either
  69 by checking it out via ::
  70
  71    svn co http://svn.python.org/projects/external/docutils-0.4/docutils tools/docutils
  72
  73 or by installing it from http://docutils.sf.net/.
  74
  75 You can optionally also install Pygments, either as a checkout via ::
  76
  77    svn co http://svn.python.org/projects/external/Pygments-0.9/pygments tools/pygments
  78
  79 or from PyPI at http://pypi.python.org/pypi/Pygments.
  80
  81
  82 Then, make an output directory, e.g. under `build/`, and run ::
  83
  84    python tools/sphinx-build.py -b<builder> . build/<outputdirectory>
  85
  86 where `<builder>` is one of html, web or htmlhelp (for explanations see the make
  87 targets above).
  88
  89
  90 Contributing
  91 ============
  92
  93 For bugs in the content, the online version at http://docs.python.org/ has a
  94 "suggest change" facility that can be used to correct errors in the source text
  95 and submit them as a patch to the maintainers.
  96
  97 Bugs in the toolset should be reported in the Python bug tracker at
  98 http://bugs.python.org/.
  99
 100 You can also send a mail to the Python Documentation Team at docs@python.org,
 101 and we will process your request as soon as possible.
 102
 103 If you want to help the Documentation Team, you are always welcome.  Just send
 104 a mail to docs@python.org.
 105
 106
 107 Copyright notice
 108 ================
 109
 110 The Python source is copyrighted, but you can freely use and copy it
 111 as long as you don't change or remove the copyright notice:
 112
 113 ----------------------------------------------------------------------
 114 Copyright (c) 2000-2007 Python Software Foundation.
 115 All rights reserved.
 116
 117 Copyright (c) 2000 BeOpen.com.
 118 All rights reserved.
 119
 120 Copyright (c) 1995-2000 Corporation for National Research Initiatives.
 121 All rights reserved.
 122
 123 Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
 124 All rights reserved.
 125
 126 See the file "license.rst" for information on usage and redistribution
 127 of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 128 ----------------------------------------------------------------------