mirror of
https://github.com/python/cpython.git
synced 2025-11-01 10:45:30 +00:00
292d351fc1
svn+ssh://pythondev@svn.python.org/python/trunk
NOTE: I blocked the following revisions:
svnmerge.py block -r 60521,60522,60528,60529,60534,60539
The new tests must be merged with lots of manual work.
........
r60493 | georg.brandl | 2008-02-01 12:59:08 +0100 (Fri, 01 Feb 2008) | 2 lines
Update IPv6 RFC number.
........
r60497 | georg.brandl | 2008-02-01 16:50:15 +0100 (Fri, 01 Feb 2008) | 2 lines
Add link checker builder, written for GHOP by Thomas Lamb.
........
r60500 | georg.brandl | 2008-02-01 19:08:09 +0100 (Fri, 01 Feb 2008) | 2 lines
Rename batch file.
........
r60504 | christian.heimes | 2008-02-01 19:49:26 +0100 (Fri, 01 Feb 2008) | 1 line
More int -> pid_t.
........
r60507 | georg.brandl | 2008-02-01 20:24:01 +0100 (Fri, 01 Feb 2008) | 2 lines
Wording nit.
........
r60510 | georg.brandl | 2008-02-01 21:45:33 +0100 (Fri, 01 Feb 2008) | 2 lines
Update for latest sphinx latex writer.
........
r60511 | raymond.hettinger | 2008-02-01 22:30:23 +0100 (Fri, 01 Feb 2008) | 1 line
Issue #1996: float.as_integer_ratio() should return fraction in lowest terms.
........
r60512 | raymond.hettinger | 2008-02-01 23:15:52 +0100 (Fri, 01 Feb 2008) | 1 line
Integer ratio should return ints instead of longs whereever possible.
........
r60513 | raymond.hettinger | 2008-02-01 23:22:50 +0100 (Fri, 01 Feb 2008) | 1 line
labs() takes a long for an input.
........
r60514 | raymond.hettinger | 2008-02-01 23:42:59 +0100 (Fri, 01 Feb 2008) | 1 line
Test round-trip on float.as_integer_ratio() and float.__truediv__().
........
r60515 | marc-andre.lemburg | 2008-02-01 23:58:17 +0100 (Fri, 01 Feb 2008) | 3 lines
Bump distutils version number to match Python version.
........
r60516 | raymond.hettinger | 2008-02-02 00:12:19 +0100 (Sat, 02 Feb 2008) | 1 line
Fix int/long typecase. Add check for non-binary floating point.
........
r60517 | raymond.hettinger | 2008-02-02 00:45:44 +0100 (Sat, 02 Feb 2008) | 1 line
Add protection from weirdness while scaling the mantissa to an integer.
........
r60518 | raymond.hettinger | 2008-02-02 06:11:40 +0100 (Sat, 02 Feb 2008) | 1 line
Simpler solution to handling non-IEEE 754 environments.
........
r60519 | raymond.hettinger | 2008-02-02 06:24:44 +0100 (Sat, 02 Feb 2008) | 1 line
Neaten-up a bit.
........
r60520 | georg.brandl | 2008-02-02 10:56:20 +0100 (Sat, 02 Feb 2008) | 2 lines
Amendments to the urllib2 docs, written for GHOP by Thomas Lamb.
........
r60525 | georg.brandl | 2008-02-02 11:49:58 +0100 (Sat, 02 Feb 2008) | 3 lines
Add email example how to send a multipart message.
Written for GHOP by Martin Matejek.
........
r60526 | georg.brandl | 2008-02-02 12:05:00 +0100 (Sat, 02 Feb 2008) | 2 lines
Rewrite test_socketserver as unittest, written for GHOP by Benjamin Petersen.
........
r60527 | georg.brandl | 2008-02-02 12:05:34 +0100 (Sat, 02 Feb 2008) | 2 lines
Add GHOP contributor.
........
r60530 | mark.dickinson | 2008-02-02 18:16:13 +0100 (Sat, 02 Feb 2008) | 2 lines
Make the Rational constructor accept '3.' and '.2' as well as '3.2'.
........
r60531 | neal.norwitz | 2008-02-02 19:52:51 +0100 (Sat, 02 Feb 2008) | 1 line
Update the leaky tests (ie, ignore these tests if they report leaks). This version has been running for a while.
........
r60533 | skip.montanaro | 2008-02-02 20:11:57 +0100 (Sat, 02 Feb 2008) | 7 lines
Split the refleak mail body into two parts, the first being those failing
tests which are deemed more important issues, the second those which are
known to have difficult to solve problems and are generally expected to
leak. Hopefully this doesn't break the script...
........
r60535 | georg.brandl | 2008-02-03 01:04:50 +0100 (Sun, 03 Feb 2008) | 3 lines
Wait for a delay before reaping children -- this should fix the
test_socketserver failures on several platforms.
........
r60536 | brett.cannon | 2008-02-03 03:07:55 +0100 (Sun, 03 Feb 2008) | 2 lines
Fix a minor typo.
........
r60537 | brett.cannon | 2008-02-03 03:08:45 +0100 (Sun, 03 Feb 2008) | 3 lines
Directories from CPPFLAGS and LDFLAGS were being added in the reverse order for
searches as to how they were listed in the environment variable.
........
r60538 | brett.cannon | 2008-02-03 03:34:14 +0100 (Sun, 03 Feb 2008) | 2 lines
Remove extra tick marks and add a missing closing parenthesis.
........
r60540 | andrew.macintyre | 2008-02-03 07:58:06 +0100 (Sun, 03 Feb 2008) | 2 lines
Update OS/2 EMX build bits for 2.6.
........
r60541 | andrew.macintyre | 2008-02-03 08:01:11 +0100 (Sun, 03 Feb 2008) | 2 lines
Rename module definition file to reflect v2.6.
........
r60542 | andrew.macintyre | 2008-02-03 08:07:31 +0100 (Sun, 03 Feb 2008) | 6 lines
The wrapper function is supposed to be for spawnvpe() so that's
what we should call [this wrapper only available on OS/2].
Backport candidate to 2.5.
........
r60544 | gregory.p.smith | 2008-02-03 08:20:53 +0100 (Sun, 03 Feb 2008) | 6 lines
Merge this fix from the pybsddb tree:
r293 | jcea | 2008-01-31 01:08:19 -0800 (Thu, 31 Jan 2008) | 4 lines
Solved memory leak when using cursors with
databases without environment.
........
r60546 | gregory.p.smith | 2008-02-03 09:01:46 +0100 (Sun, 03 Feb 2008) | 2 lines
remove a repeated occurance of a hardcoded berkeleydb library version number
........
r60549 | brett.cannon | 2008-02-03 10:59:21 +0100 (Sun, 03 Feb 2008) | 2 lines
Add an entry for r60537.
........
r60550 | georg.brandl | 2008-02-03 13:29:00 +0100 (Sun, 03 Feb 2008) | 2 lines
#2003: fix sentence.
........
r60551 | christian.heimes | 2008-02-03 15:34:18 +0100 (Sun, 03 Feb 2008) | 2 lines
Fixed paths to Windows build directories in build_ext.py
Use vsbuild instead of devenv in build.bat and _bsddb.vcproj
........
137 lines
4.8 KiB
Text
137 lines
4.8 KiB
Text
Python Documentation README
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
This directory contains the reStructuredText (reST) sources to the Python
|
|
documentation. You don't need to build them yourself, prebuilt versions are
|
|
available at http://docs.python.org/download/.
|
|
|
|
Documentation on the authoring Python documentation, including information about
|
|
both style and markup, is available in the "Documenting Python" chapter of the
|
|
documentation. There's also a chapter intended to point out differences to
|
|
those familiar with the previous docs written in LaTeX.
|
|
|
|
|
|
Building the docs
|
|
=================
|
|
|
|
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
|
|
----------
|
|
|
|
Luckily, a Makefile has been prepared so that on Unix, provided you have
|
|
installed Python and Subversion, you can just run ::
|
|
|
|
make html
|
|
|
|
to check out the necessary toolset in the `tools/` subdirectory and build the
|
|
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.
|
|
|
|
* "web", which builds files usable with the Sphinx.web application (used to
|
|
serve the docs online at http://docs.python.org/).
|
|
|
|
* "htmlhelp", which builds HTML files and a HTML Help project file usable to
|
|
convert them into a single Compiled HTML (.chm) file -- these are popular
|
|
under Microsoft Windows, but very handy on every platform.
|
|
|
|
To create the CHM file, you need to run the Microsoft HTML Help Workshop
|
|
over the generated project (.hhp) file.
|
|
|
|
* "latex", which builds LaTeX source files that can be run with "pdflatex"
|
|
to produce PDF documents.
|
|
|
|
* "linkcheck", which checks all external references to see whether they are
|
|
broken, redirected or malformed, and outputs this information to stdout
|
|
as well as a plain-text (.txt) file.
|
|
|
|
* "changes", which builds an overview over all versionadded/versionchanged/
|
|
deprecated items in the current version. This is meant as a help for the
|
|
writer of the "What's New" document.
|
|
|
|
A "make update" updates the Subversion checkouts in `tools/`.
|
|
|
|
|
|
Without make
|
|
------------
|
|
|
|
You'll need to checkout the Sphinx package to the `tools/` directory::
|
|
|
|
svn co http://svn.python.org/projects/doctools/trunk/sphinx tools/sphinx
|
|
|
|
Then, you need to install Docutils 0.4 (the SVN snapshot won't work), either
|
|
by checking it out via ::
|
|
|
|
svn co http://svn.python.org/projects/external/docutils-0.4/docutils tools/docutils
|
|
|
|
or by installing it from http://docutils.sf.net/.
|
|
|
|
You can optionally also install Pygments, either as a checkout via ::
|
|
|
|
svn co http://svn.python.org/projects/external/Pygments-0.9/pygments tools/pygments
|
|
|
|
or from PyPI at http://pypi.python.org/pypi/Pygments.
|
|
|
|
|
|
Then, make an output directory, e.g. under `build/`, and run ::
|
|
|
|
python tools/sphinx-build.py -b<builder> . build/<outputdirectory>
|
|
|
|
where `<builder>` is one of html, web or htmlhelp (for explanations see the make
|
|
targets above).
|
|
|
|
|
|
Contributing
|
|
============
|
|
|
|
For bugs in the content, the online version at http://docs.python.org/ has a
|
|
"suggest change" facility that can be used to correct errors in the source text
|
|
and submit them as a patch to the maintainers.
|
|
|
|
Bugs in the toolset should be reported in the Python bug tracker at
|
|
http://bugs.python.org/.
|
|
|
|
You can also send a mail to the Python Documentation Team at docs@python.org,
|
|
and we will process your request as soon as possible.
|
|
|
|
If you want to help the Documentation Team, you are always welcome. Just send
|
|
a mail to docs@python.org.
|
|
|
|
|
|
Copyright notice
|
|
================
|
|
|
|
The Python source is copyrighted, but you can freely use and copy it
|
|
as long as you don't change or remove the copyright notice:
|
|
|
|
----------------------------------------------------------------------
|
|
Copyright (c) 2000-2007 Python Software Foundation.
|
|
All rights reserved.
|
|
|
|
Copyright (c) 2000 BeOpen.com.
|
|
All rights reserved.
|
|
|
|
Copyright (c) 1995-2000 Corporation for National Research Initiatives.
|
|
All rights reserved.
|
|
|
|
Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
|
|
All rights reserved.
|
|
|
|
See the file "license.rst" for information on usage and redistribution
|
|
of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
|
----------------------------------------------------------------------
|