mirror of
https://github.com/python/cpython.git
synced 2024-12-01 03:01:36 +01:00
d3eb5a1581
svn+ssh://pythondev@svn.python.org/python/trunk
........
r61004 | georg.brandl | 2008-02-23 19:47:04 +0100 (Sat, 23 Feb 2008) | 2 lines
Documentation coverage builder, part 1.
........
r61006 | andrew.kuchling | 2008-02-23 20:02:33 +0100 (Sat, 23 Feb 2008) | 1 line
#1389051: IMAP module tries to read entire message in one chunk. Patch by Fredrik Lundh.
........
r61008 | andrew.kuchling | 2008-02-23 20:28:58 +0100 (Sat, 23 Feb 2008) | 1 line
#1389051, #1092502: fix excessively large allocations when using read() on a socket
........
r61011 | jeffrey.yasskin | 2008-02-23 20:40:54 +0100 (Sat, 23 Feb 2008) | 13 lines
Prevent classes like:
class RunSelfFunction(object):
def __init__(self):
self.thread = threading.Thread(target=self._run)
self.thread.start()
def _run(self):
pass
from creating a permanent cycle between the object and the thread by having the
Thread delete its references to the object when it completes.
As an example of the effect of this bug, paramiko.Transport inherits from
Thread to avoid it.
........
r61013 | jeffrey.yasskin | 2008-02-23 21:40:35 +0100 (Sat, 23 Feb 2008) | 3 lines
Followup to r61011: Also avoid the reference cycle when the Thread's target
raises an exception.
........
r61017 | georg.brandl | 2008-02-23 22:59:11 +0100 (Sat, 23 Feb 2008) | 2 lines
#2101: fix removeAttribute docs.
........
r61018 | georg.brandl | 2008-02-23 23:05:38 +0100 (Sat, 23 Feb 2008) | 2 lines
Add examples to modulefinder docs. Written for GHOP by Josip Dzolonga.
........
r61019 | georg.brandl | 2008-02-23 23:09:24 +0100 (Sat, 23 Feb 2008) | 2 lines
Use os.closerange() in popen2.
........
r61020 | georg.brandl | 2008-02-23 23:14:02 +0100 (Sat, 23 Feb 2008) | 2 lines
Use os.closerange().
........
r61021 | georg.brandl | 2008-02-23 23:35:33 +0100 (Sat, 23 Feb 2008) | 3 lines
In test_heapq and test_bisect, test both the Python and the C implementation.
Originally written for GHOP by Josip Dzolonga, heavily patched by me.
........
r61024 | facundo.batista | 2008-02-23 23:54:12 +0100 (Sat, 23 Feb 2008) | 3 lines
Added simple test case. Thanks Benjamin Peterson.
........
r61025 | georg.brandl | 2008-02-23 23:55:18 +0100 (Sat, 23 Feb 2008) | 2 lines
#1825: correctly document msilib.add_data.
........
r61027 | georg.brandl | 2008-02-24 00:02:23 +0100 (Sun, 24 Feb 2008) | 2 lines
#1826: allow dotted attribute paths in operator.attrgetter.
........
r61028 | georg.brandl | 2008-02-24 00:04:35 +0100 (Sun, 24 Feb 2008) | 2 lines
#1506171: added operator.methodcaller().
........
r61029 | georg.brandl | 2008-02-24 00:25:26 +0100 (Sun, 24 Feb 2008) | 2 lines
Document import ./. threading issues. #1720705.
........
r61032 | georg.brandl | 2008-02-24 00:43:01 +0100 (Sun, 24 Feb 2008) | 2 lines
Specify what kind of warning -3 emits.
........
r61033 | christian.heimes | 2008-02-24 00:59:45 +0100 (Sun, 24 Feb 2008) | 1 line
MS Windows doesn't have mode_t but stat.st_mode is defined as unsigned short.
........
141 lines
4.8 KiB
Plaintext
141 lines
4.8 KiB
Plaintext
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.4 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.
|
|
|
|
* "coverage", which builds a coverage overview for standard library modules
|
|
and C API.
|
|
|
|
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.
|
|
----------------------------------------------------------------------
|