-
-
Notifications
You must be signed in to change notification settings - Fork 30.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move the 2.6 reST doc tree in place.
- Loading branch information
1 parent
f56181f
commit 8ec7f65
Showing
445 changed files
with
136,056 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,196 @@ | ||
Contributors to the Python Documentation | ||
---------------------------------------- | ||
|
||
This file lists people who have contributed in some way to the Python | ||
documentation. It is probably not complete -- if you feel that you or | ||
anyone else should be on this list, please let us know (send email to | ||
docs@python.org), and we'll be glad to correct the problem. | ||
|
||
* Aahz | ||
* Michael Abbott | ||
* Steve Alexander | ||
* Jim Ahlstrom | ||
* Fred Allen | ||
* A. Amoroso | ||
* Pehr Anderson | ||
* Oliver Andrich | ||
* Jesús Cea Avión | ||
* Daniel Barclay | ||
* Chris Barker | ||
* Don Bashford | ||
* Anthony Baxter | ||
* Bennett Benson | ||
* Jonathan Black | ||
* Robin Boerdijk | ||
* Michal Bozon | ||
* Aaron Brancotti | ||
* Georg Brandl | ||
* Keith Briggs | ||
* Lee Busby | ||
* Lorenzo M. Catucci | ||
* Carl Cerecke | ||
* Mauro Cicognini | ||
* Gilles Civario | ||
* Mike Clarkson | ||
* Steve Clift | ||
* Dave Cole | ||
* Matthew Cowles | ||
* Jeremy Craven | ||
* Andrew Dalke | ||
* Ben Darnell | ||
* L. Peter Deutsch | ||
* Robert Donohue | ||
* Fred L. Drake, Jr. | ||
* Jeff Epler | ||
* Michael Ernst | ||
* Blame Andy Eskilsson | ||
* Carey Evans | ||
* Martijn Faassen | ||
* Carl Feynman | ||
* Hernán Martínez Foffani | ||
* Stefan Franke | ||
* Jim Fulton | ||
* Peter Funk | ||
* Lele Gaifax | ||
* Matthew Gallagher | ||
* Ben Gertzfield | ||
* Nadim Ghaznavi | ||
* Jonathan Giddy | ||
* Shelley Gooch | ||
* Nathaniel Gray | ||
* Grant Griffin | ||
* Thomas Guettler | ||
* Anders Hammarquist | ||
* Mark Hammond | ||
* Harald Hanche-Olsen | ||
* Manus Hand | ||
* Gerhard Häring | ||
* Travis B. Hartwell | ||
* Tim Hatch | ||
* Janko Hauser | ||
* Bernhard Herzog | ||
* Magnus L. Hetland | ||
* Konrad Hinsen | ||
* Stefan Hoffmeister | ||
* Albert Hofkamp | ||
* Gregor Hoffleit | ||
* Steve Holden | ||
* Thomas Holenstein | ||
* Gerrit Holl | ||
* Rob Hooft | ||
* Brian Hooper | ||
* Randall Hopper | ||
* Michael Hudson | ||
* Eric Huss | ||
* Jeremy Hylton | ||
* Roger Irwin | ||
* Jack Jansen | ||
* Philip H. Jensen | ||
* Pedro Diaz Jimenez | ||
* Kent Johnson | ||
* Lucas de Jonge | ||
* Andreas Jung | ||
* Robert Kern | ||
* Jim Kerr | ||
* Jan Kim | ||
* Greg Kochanski | ||
* Guido Kollerie | ||
* Peter A. Koren | ||
* Daniel Kozan | ||
* Andrew M. Kuchling | ||
* Dave Kuhlman | ||
* Erno Kuusela | ||
* Detlef Lannert | ||
* Piers Lauder | ||
* Glyph Lefkowitz | ||
* Marc-André Lemburg | ||
* Ulf A. Lindgren | ||
* Everett Lipman | ||
* Mirko Liss | ||
* Martin von Löwis | ||
* Fredrik Lundh | ||
* Jeff MacDonald | ||
* John Machin | ||
* Andrew MacIntyre | ||
* Vladimir Marangozov | ||
* Vincent Marchetti | ||
* Laura Matson | ||
* Daniel May | ||
* Doug Mennella | ||
* Paolo Milani | ||
* Skip Montanaro | ||
* Paul Moore | ||
* Ross Moore | ||
* Sjoerd Mullender | ||
* Dale Nagata | ||
* Ng Pheng Siong | ||
* Koray Oner | ||
* Tomas Oppelstrup | ||
* Denis S. Otkidach | ||
* Zooko O'Whielacronx | ||
* William Park | ||
* Joonas Paalasmaa | ||
* Harri Pasanen | ||
* Bo Peng | ||
* Tim Peters | ||
* Christopher Petrilli | ||
* Justin D. Pettit | ||
* Chris Phoenix | ||
* François Pinard | ||
* Paul Prescod | ||
* Eric S. Raymond | ||
* Edward K. Ream | ||
* Sean Reifschneider | ||
* Bernhard Reiter | ||
* Armin Rigo | ||
* Wes Rishel | ||
* Jim Roskind | ||
* Guido van Rossum | ||
* Donald Wallace Rouse II | ||
* Nick Russo | ||
* Chris Ryland | ||
* Constantina S. | ||
* Hugh Sasse | ||
* Bob Savage | ||
* Scott Schram | ||
* Neil Schemenauer | ||
* Barry Scott | ||
* Joakim Sernbrant | ||
* Justin Sheehy | ||
* Michael Simcich | ||
* Ionel Simionescu | ||
* Gregory P. Smith | ||
* Roy Smith | ||
* Clay Spence | ||
* Nicholas Spies | ||
* Tage Stabell-Kulo | ||
* Frank Stajano | ||
* Anthony Starks | ||
* Greg Stein | ||
* Peter Stoehr | ||
* Mark Summerfield | ||
* Reuben Sumner | ||
* Kalle Svensson | ||
* Jim Tittsler | ||
* Ville Vainio | ||
* Martijn Vries | ||
* Charles G. Waldman | ||
* Greg Ward | ||
* Barry Warsaw | ||
* Corran Webster | ||
* Glyn Webster | ||
* Bob Weiner | ||
* Eddy Welbourne | ||
* Mats Wichmann | ||
* Gerry Wiener | ||
* Timothy Wild | ||
* Collin Winter | ||
* Blake Winton | ||
* Dan Wolfe | ||
* Steven Work | ||
* Thomas Wouters | ||
* Ka-Ping Yee | ||
* Rory Yorke | ||
* Moshe Zadka | ||
* Milan Zamazal | ||
* Cheng Zhang |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# | ||
# Makefile for Python documentation | ||
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
# | ||
|
||
# You can set these variables from the command line. | ||
PYTHON ?= python | ||
SVNROOT ?= http://svn.python.org/projects | ||
SPHINXOPTS ?= | ||
|
||
ALLSPHINXOPTS = -b$(BUILDER) -dbuild/doctrees $(SPHINXOPTS) . build/$(BUILDER) | ||
|
||
.PHONY: help checkout update build html web htmlhelp clean | ||
|
||
help: | ||
@echo "Please use \`make <target>' where <target> is one of" | ||
@echo " html to make standalone HTML files" | ||
@echo " web to make file usable by Sphinx.web" | ||
@echo " htmlhelp to make HTML files and a HTML help project" | ||
|
||
checkout: | ||
@if [ ! -d tools/sphinx ]; then \ | ||
echo "Checking out Sphinx..."; \ | ||
svn checkout $(SVNROOT)/doctools/trunk/sphinx tools/sphinx; \ | ||
fi | ||
@if [ ! -d tools/docutils ]; then \ | ||
echo "Checking out Docutils..."; \ | ||
svn checkout $(SVNROOT)/external/docutils-0.4/docutils tools/docutils; \ | ||
fi | ||
@if [ ! -d tools/pygments ]; then \ | ||
echo "Checking out Pygments..."; \ | ||
svn checkout $(SVNROOT)/external/Pygments-0.8.1/pygments tools/pygments; \ | ||
fi | ||
|
||
update: | ||
svn update tools/sphinx | ||
svn update tools/docutils | ||
svn update tools/pygments | ||
|
||
build: checkout | ||
mkdir -p build/$(BUILDER) build/doctrees | ||
$(PYTHON) tools/sphinx-build.py $(ALLSPHINXOPTS) | ||
@echo | ||
|
||
html: BUILDER = html | ||
html: build | ||
@echo "Build finished. The HTML pages are in build/html." | ||
|
||
web: BUILDER = web | ||
web: build | ||
@echo "Build finished; now you can run" | ||
@echo " PYTHONPATH=tools $(PYTHON) -m sphinx.web build/web" | ||
@echo "to start the server." | ||
|
||
htmlhelp: BUILDER = htmlhelp | ||
htmlhelp: build | ||
@echo "Build finished; now you can run HTML Help Workshop with the" \ | ||
"build/hhp/pydoc.hhp project file." | ||
|
||
clean: | ||
-rm -rf build/* | ||
-rm -rf tools/sphinx |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
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 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. | ||
|
||
|
||
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". | ||
|
||
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. | ||
|
||
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.8.1/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. | ||
---------------------------------------------------------------------- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
To do | ||
===== | ||
|
||
* split very large files and add toctrees | ||
* finish "Documenting Python" | ||
* care about XXX comments |
Oops, something went wrong.