Skip to content

Commit 116aa62

Browse files
birkenfeldbirkenfeld
committed
Move the 3k reST doc tree in place.
1 parent 739c01d commit 116aa62

File tree

423 files changed

+131199
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

423 files changed

+131199
-0
lines changed

‎Doc/ACKS.txt

+196
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,196 @@
1+
Contributors to the Python Documentation
2+
----------------------------------------
3+
4+
This file lists people who have contributed in some way to the Python
5+
documentation. It is probably not complete -- if you feel that you or
6+
anyone else should be on this list, please let us know (send email to
7+
docs@python.org), and we'll be glad to correct the problem.
8+
9+
* Aahz
10+
* Michael Abbott
11+
* Steve Alexander
12+
* Jim Ahlstrom
13+
* Fred Allen
14+
* A. Amoroso
15+
* Pehr Anderson
16+
* Oliver Andrich
17+
* Jesús Cea Avión
18+
* Daniel Barclay
19+
* Chris Barker
20+
* Don Bashford
21+
* Anthony Baxter
22+
* Bennett Benson
23+
* Jonathan Black
24+
* Robin Boerdijk
25+
* Michal Bozon
26+
* Aaron Brancotti
27+
* Georg Brandl
28+
* Keith Briggs
29+
* Lee Busby
30+
* Lorenzo M. Catucci
31+
* Carl Cerecke
32+
* Mauro Cicognini
33+
* Gilles Civario
34+
* Mike Clarkson
35+
* Steve Clift
36+
* Dave Cole
37+
* Matthew Cowles
38+
* Jeremy Craven
39+
* Andrew Dalke
40+
* Ben Darnell
41+
* L. Peter Deutsch
42+
* Robert Donohue
43+
* Fred L. Drake, Jr.
44+
* Jeff Epler
45+
* Michael Ernst
46+
* Blame Andy Eskilsson
47+
* Carey Evans
48+
* Martijn Faassen
49+
* Carl Feynman
50+
* Hernán Martínez Foffani
51+
* Stefan Franke
52+
* Jim Fulton
53+
* Peter Funk
54+
* Lele Gaifax
55+
* Matthew Gallagher
56+
* Ben Gertzfield
57+
* Nadim Ghaznavi
58+
* Jonathan Giddy
59+
* Shelley Gooch
60+
* Nathaniel Gray
61+
* Grant Griffin
62+
* Thomas Guettler
63+
* Anders Hammarquist
64+
* Mark Hammond
65+
* Harald Hanche-Olsen
66+
* Manus Hand
67+
* Gerhard Häring
68+
* Travis B. Hartwell
69+
* Tim Hatch
70+
* Janko Hauser
71+
* Bernhard Herzog
72+
* Magnus L. Hetland
73+
* Konrad Hinsen
74+
* Stefan Hoffmeister
75+
* Albert Hofkamp
76+
* Gregor Hoffleit
77+
* Steve Holden
78+
* Thomas Holenstein
79+
* Gerrit Holl
80+
* Rob Hooft
81+
* Brian Hooper
82+
* Randall Hopper
83+
* Michael Hudson
84+
* Eric Huss
85+
* Jeremy Hylton
86+
* Roger Irwin
87+
* Jack Jansen
88+
* Philip H. Jensen
89+
* Pedro Diaz Jimenez
90+
* Kent Johnson
91+
* Lucas de Jonge
92+
* Andreas Jung
93+
* Robert Kern
94+
* Jim Kerr
95+
* Jan Kim
96+
* Greg Kochanski
97+
* Guido Kollerie
98+
* Peter A. Koren
99+
* Daniel Kozan
100+
* Andrew M. Kuchling
101+
* Dave Kuhlman
102+
* Erno Kuusela
103+
* Detlef Lannert
104+
* Piers Lauder
105+
* Glyph Lefkowitz
106+
* Marc-André Lemburg
107+
* Ulf A. Lindgren
108+
* Everett Lipman
109+
* Mirko Liss
110+
* Martin von Löwis
111+
* Fredrik Lundh
112+
* Jeff MacDonald
113+
* John Machin
114+
* Andrew MacIntyre
115+
* Vladimir Marangozov
116+
* Vincent Marchetti
117+
* Laura Matson
118+
* Daniel May
119+
* Doug Mennella
120+
* Paolo Milani
121+
* Skip Montanaro
122+
* Paul Moore
123+
* Ross Moore
124+
* Sjoerd Mullender
125+
* Dale Nagata
126+
* Ng Pheng Siong
127+
* Koray Oner
128+
* Tomas Oppelstrup
129+
* Denis S. Otkidach
130+
* Zooko O'Whielacronx
131+
* William Park
132+
* Joonas Paalasmaa
133+
* Harri Pasanen
134+
* Bo Peng
135+
* Tim Peters
136+
* Christopher Petrilli
137+
* Justin D. Pettit
138+
* Chris Phoenix
139+
* François Pinard
140+
* Paul Prescod
141+
* Eric S. Raymond
142+
* Edward K. Ream
143+
* Sean Reifschneider
144+
* Bernhard Reiter
145+
* Armin Rigo
146+
* Wes Rishel
147+
* Jim Roskind
148+
* Guido van Rossum
149+
* Donald Wallace Rouse II
150+
* Nick Russo
151+
* Chris Ryland
152+
* Constantina S.
153+
* Hugh Sasse
154+
* Bob Savage
155+
* Scott Schram
156+
* Neil Schemenauer
157+
* Barry Scott
158+
* Joakim Sernbrant
159+
* Justin Sheehy
160+
* Michael Simcich
161+
* Ionel Simionescu
162+
* Gregory P. Smith
163+
* Roy Smith
164+
* Clay Spence
165+
* Nicholas Spies
166+
* Tage Stabell-Kulo
167+
* Frank Stajano
168+
* Anthony Starks
169+
* Greg Stein
170+
* Peter Stoehr
171+
* Mark Summerfield
172+
* Reuben Sumner
173+
* Kalle Svensson
174+
* Jim Tittsler
175+
* Ville Vainio
176+
* Martijn Vries
177+
* Charles G. Waldman
178+
* Greg Ward
179+
* Barry Warsaw
180+
* Corran Webster
181+
* Glyn Webster
182+
* Bob Weiner
183+
* Eddy Welbourne
184+
* Mats Wichmann
185+
* Gerry Wiener
186+
* Timothy Wild
187+
* Collin Winter
188+
* Blake Winton
189+
* Dan Wolfe
190+
* Steven Work
191+
* Thomas Wouters
192+
* Ka-Ping Yee
193+
* Rory Yorke
194+
* Moshe Zadka
195+
* Milan Zamazal
196+
* Cheng Zhang

‎Doc/Makefile

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
#
2+
# Makefile for Python documentation
3+
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4+
#
5+
6+
# You can set these variables from the command line.
7+
PYTHON ?= python
8+
SVNROOT ?= http://svn.python.org/projects
9+
SPHINXOPTS ?=
10+
11+
ALLSPHINXOPTS = -b$(BUILDER) -dbuild/doctrees $(SPHINXOPTS) . build/$(BUILDER)
12+
13+
.PHONY: help checkout update build html web htmlhelp clean
14+
15+
help:
16+
@echo "Please use \`make <target>' where <target> is one of"
17+
@echo " html to make standalone HTML files"
18+
@echo " web to make file usable by Sphinx.web"
19+
@echo " htmlhelp to make HTML files and a HTML help project"
20+
21+
checkout:
22+
@if [ ! -d tools/sphinx ]; then \
23+
echo "Checking out Sphinx..."; \
24+
svn checkout $(SVNROOT)/doctools/trunk/sphinx tools/sphinx; \
25+
fi
26+
@if [ ! -d tools/docutils ]; then \
27+
echo "Checking out Docutils..."; \
28+
svn checkout $(SVNROOT)/external/docutils-0.4/docutils tools/docutils; \
29+
fi
30+
@if [ ! -d tools/pygments ]; then \
31+
echo "Checking out Pygments..."; \
32+
svn checkout $(SVNROOT)/external/Pygments-0.8.1/pygments tools/pygments; \
33+
fi
34+
35+
update:
36+
svn update tools/sphinx
37+
svn update tools/docutils
38+
svn update tools/pygments
39+
40+
build: checkout
41+
mkdir -p build/$(BUILDER) build/doctrees
42+
$(PYTHON) tools/sphinx-build.py $(ALLSPHINXOPTS)
43+
@echo
44+
45+
html: BUILDER = html
46+
html: build
47+
@echo "Build finished. The HTML pages are in build/html."
48+
49+
web: BUILDER = web
50+
web: build
51+
@echo "Build finished; now you can run"
52+
@echo " PYTHONPATH=tools $(PYTHON) -m sphinx.web build/web"
53+
@echo "to start the server."
54+
55+
htmlhelp: BUILDER = htmlhelp
56+
htmlhelp: build
57+
@echo "Build finished; now you can run HTML Help Workshop with the" \
58+
"build/hhp/pydoc.hhp project file."
59+
60+
clean:
61+
-rm -rf build/*
62+
-rm -rf tools/sphinx

‎Doc/README.txt

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

‎Doc/TODO.txt

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
To do
2+
=====
3+
4+
* split very large files and add toctrees
5+
* finish "Documenting Python"
6+
* care about XXX comments

0 commit comments

Comments
 (0)