Building the docs
=================
-You need to install Python 2.5 or higher; the toolset used to build the docs are
-written in Python. The toolset used to build the documentation is called
-*Sphinx*, it is not included in this tree, but maintained separately in the
-Python Subversion repository. Also needed are Jinja, a templating engine
-(included in Sphinx as a Subversion external), and optionally Pygments, a code
-highlighter.
+You need to install Python 2.5.1 or higher (but Python 3.0 is not supported yet);
+the toolset used to build the docs are written in Python. The toolset used
+to build the documentation is called *Sphinx*, it is not included in this
+tree, but maintained separately in the Python Subversion repository. Also
+needed are Jinja, a templating engine (included in Sphinx as a Subversion
+external), and optionally Pygments, a code highlighter.
Using make
HTML output files. To view the generated HTML, point your favorite browser at
the top-level index `build/html/index.html` after running "make".
+To use a Python interpreter that's not called ``python``, use the standard
+way to set Makefile variables, using e.g. ::
+
+ make html PYTHON=/usr/bin/python2.5
+
Available make targets are:
* "html", which builds standalone HTML files for offline viewing.
Source Definition). Historically, most, but not all, Python releases have also
been GPL-compatible; the table below summarizes the various releases.
-+----------------+--------------+-----------+------------+-----------------+
-| Release | Derived from | Year | Owner | GPL compatible? |
-+================+==============+===========+============+=================+
-| 0.9.0 thru 1.2 | n/a | 1991-1995 | CWI | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 1.3 thru 1.5.2 | 1.2 | 1995-1999 | CNRI | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 1.6 | 1.5.2 | 2000 | CNRI | no |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.0 | 1.6 | 2000 | BeOpen.com | no |
-+----------------+--------------+-----------+------------+-----------------+
-| 1.6.1 | 1.6 | 2001 | CNRI | no |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.1 | 2.0+1.6.1 | 2001 | PSF | no |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.0.1 | 2.0+1.6.1 | 2001 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.1.1 | 2.1+2.0.1 | 2001 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.2 | 2.1.1 | 2001 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.1.2 | 2.1.1 | 2002 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.1.3 | 2.1.2 | 2002 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.2.1 | 2.2 | 2002 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.2.2 | 2.2.1 | 2002 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.2.3 | 2.2.2 | 2002-2003 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.3 | 2.2.2 | 2002-2003 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.3.1 | 2.3 | 2002-2003 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.3.2 | 2.3.1 | 2003 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.3.3 | 2.3.2 | 2003 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.3.4 | 2.3.3 | 2004 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.3.5 | 2.3.4 | 2005 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.4 | 2.3 | 2004 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.4.1 | 2.4 | 2005 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.4.2 | 2.4.1 | 2005 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.4.3 | 2.4.2 | 2006 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.4.4 | 2.4.3 | 2006 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.5 | 2.4 | 2006 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
-| 2.5.1 | 2.5 | 2007 | PSF | yes |
-+----------------+--------------+-----------+------------+-----------------+
++----------------+--------------+------------+------------+-----------------+
+| Release | Derived from | Year | Owner | GPL compatible? |
++================+==============+============+============+=================+
+| 0.9.0 thru 1.2 | n/a | 1991-1995 | CWI | yes |
++----------------+--------------+------------+------------+-----------------+
+| 1.3 thru 1.5.2 | 1.2 | 1995-1999 | CNRI | yes |
++----------------+--------------+------------+------------+-----------------+
+| 1.6 | 1.5.2 | 2000 | CNRI | no |
++----------------+--------------+------------+------------+-----------------+
+| 2.0 | 1.6 | 2000 | BeOpen.com | no |
++----------------+--------------+------------+------------+-----------------+
+| 1.6.1 | 1.6 | 2001 | CNRI | no |
++----------------+--------------+------------+------------+-----------------+
+| 2.1 | 2.0+1.6.1 | 2001 | PSF | no |
++----------------+--------------+------------+------------+-----------------+
+| 2.0.1 | 2.0+1.6.1 | 2001 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.1.1 | 2.1+2.0.1 | 2001 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.2 | 2.1.1 | 2001 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.1.2 | 2.1.1 | 2002 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.1.3 | 2.1.2 | 2002 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.2.1 | 2.2 | 2002 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.2.2 | 2.2.1 | 2002 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.2.3 | 2.2.2 | 2002-2003 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.3 | 2.2.2 | 2002-2003 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.3.1 | 2.3 | 2002-2003 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.3.2 | 2.3.1 | 2003 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.3.3 | 2.3.2 | 2003 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.3.4 | 2.3.3 | 2004 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.3.5 | 2.3.4 | 2005 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.4 | 2.3 | 2004 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.4.1 | 2.4 | 2005 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.4.2 | 2.4.1 | 2005 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.4.3 | 2.4.2 | 2006 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.4.4 | 2.4.3 | 2006 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.5 | 2.4 | 2006 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.5.1 | 2.5 | 2007 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 2.6 | 2.5 | unreleased | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
+| 3.0 | 2.6 | 2007 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
.. note::