Mercurial > cpython-lru_cache-weakref

annotate Doc/README.txt @ 54294:dba767bc3155 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
remove mention of old ctypes version
author Benjamin Peterson <benjamin@python.org>
date Sat, 23 May 2009 20:59:09 +0000
parents 172913e17019
children 8d9c9340b12e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
1 Python Documentation README
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
3
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
4 This directory contains the reStructuredText (reST) sources to the Python
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
5 documentation. You don't need to build them yourself, prebuilt versions are
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
6 available at http://docs.python.org/download/.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
7
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
8 Documentation on the authoring Python documentation, including information about
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
9 both style and markup, is available in the "Documenting Python" chapter of the
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
10 documentation. There's also a chapter intended to point out differences to
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
11 those familiar with the previous docs written in LaTeX.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
12
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
13
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
14 Building the docs
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
15 =================
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
16
45258
8728f816ca75 Needs only 2.4 now.
Georg Brandl <georg@python.org>
parents: 45087
diff changeset
17 You need to install Python 2.4 or higher; the toolset used to build the docs are
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
18 written in Python. The toolset used to build the documentation is called
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
19 *Sphinx*, it is not included in this tree, but maintained separately in the
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
20 Python Subversion repository. Also needed are Jinja, a templating engine
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
21 (included in Sphinx as a Subversion external), and optionally Pygments, a code
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
22 highlighter.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
23
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
24
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
25 Using make
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
26 ----------
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
27
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
28 Luckily, a Makefile has been prepared so that on Unix, provided you have
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
29 installed Python and Subversion, you can just run ::
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
30
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
31 make html
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
32
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
33 to check out the necessary toolset in the `tools/` subdirectory and build the
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
34 HTML output files. To view the generated HTML, point your favorite browser at
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
35 the top-level index `build/html/index.html` after running "make".
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
36
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
37 Available make targets are:
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
38
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
39 * "html", which builds standalone HTML files for offline viewing.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
40
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
41 * "htmlhelp", which builds HTML files and a HTML Help project file usable to
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
42 convert them into a single Compiled HTML (.chm) file -- these are popular
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
43 under Microsoft Windows, but very handy on every platform.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
44
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
45 To create the CHM file, you need to run the Microsoft HTML Help Workshop
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
46 over the generated project (.hhp) file.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
47
44103
1e266015cf5b Add more entries to the glossary.
Georg Brandl <georg@python.org>
parents: 43701
diff changeset
48 * "latex", which builds LaTeX source files that can be run with "pdflatex"
1e266015cf5b Add more entries to the glossary.
Georg Brandl <georg@python.org>
parents: 43701
diff changeset
49 to produce PDF documents.
45261
745280d71425 Fix for newest doctools.
Georg Brandl <georg@python.org>
parents: 45258
diff changeset
50
47420
e8797e6e07a7 Add plain text make target.
Georg Brandl <georg@python.org>
parents: 45590
diff changeset
51 * "text", which builds a plain text file for each source file.
e8797e6e07a7 Add plain text make target.
Georg Brandl <georg@python.org>
parents: 45590
diff changeset
52
45087
99ef248fb315 Add link checker builder, written for GHOP by Thomas Lamb.
Georg Brandl <georg@python.org>
parents: 44383
diff changeset
53 * "linkcheck", which checks all external references to see whether they are
99ef248fb315 Add link checker builder, written for GHOP by Thomas Lamb.
Georg Brandl <georg@python.org>
parents: 44383
diff changeset
54 broken, redirected or malformed, and outputs this information to stdout
99ef248fb315 Add link checker builder, written for GHOP by Thomas Lamb.
Georg Brandl <georg@python.org>
parents: 44383
diff changeset
55 as well as a plain-text (.txt) file.
44103
1e266015cf5b Add more entries to the glossary.
Georg Brandl <georg@python.org>
parents: 43701
diff changeset
56
44383
3625234bf3d2 Some cleanup in the docs.
Georg Brandl <georg@python.org>
parents: 44103
diff changeset
57 * "changes", which builds an overview over all versionadded/versionchanged/
3625234bf3d2 Some cleanup in the docs.
Georg Brandl <georg@python.org>
parents: 44103
diff changeset
58 deprecated items in the current version. This is meant as a help for the
3625234bf3d2 Some cleanup in the docs.
Georg Brandl <georg@python.org>
parents: 44103
diff changeset
59 writer of the "What's New" document.
3625234bf3d2 Some cleanup in the docs.
Georg Brandl <georg@python.org>
parents: 44103
diff changeset
60
45472
6ba5308f7ba4 Documentation coverage builder, part 1.
Georg Brandl <georg@python.org>
parents: 45261
diff changeset
61 * "coverage", which builds a coverage overview for standard library modules
6ba5308f7ba4 Documentation coverage builder, part 1.
Georg Brandl <georg@python.org>
parents: 45261
diff changeset
62 and C API.
6ba5308f7ba4 Documentation coverage builder, part 1.
Georg Brandl <georg@python.org>
parents: 45261
diff changeset
63
47431
c0d616f0ad86 Generate pydoc's topic help from the reST docs via Sphinx'
Georg Brandl <georg@python.org>
parents: 47420
diff changeset
64 * "pydoc-topics", which builds a Python module containing a dictionary
c0d616f0ad86 Generate pydoc's topic help from the reST docs via Sphinx'
Georg Brandl <georg@python.org>
parents: 47420
diff changeset
65 with plain text documentation for the labels defined in
c0d616f0ad86 Generate pydoc's topic help from the reST docs via Sphinx'
Georg Brandl <georg@python.org>
parents: 47420
diff changeset
66 `tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic
c0d616f0ad86 Generate pydoc's topic help from the reST docs via Sphinx'
Georg Brandl <georg@python.org>
parents: 47420
diff changeset
67 and keyword help.
c0d616f0ad86 Generate pydoc's topic help from the reST docs via Sphinx'
Georg Brandl <georg@python.org>
parents: 47420
diff changeset
68
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
69 A "make update" updates the Subversion checkouts in `tools/`.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
70
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
71
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
72 Without make
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
73 ------------
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
74
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
75 You'll need to checkout the Sphinx package to the `tools/` directory::
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
76
53457
172913e17019 Update versions in instructions for manual set-up.
Georg Brandl <georg@python.org>
parents: 50269
diff changeset
77 svn co http://svn.python.org/projects/external/Sphinx-0.6.1/sphinx tools/sphinx
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
78
50252
af56e3f14eb7 update readme
Benjamin Peterson <benjamin@python.org>
parents: 50251
diff changeset
79 Then, you need to install Docutils, either by checking it out via ::
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
80
53457
172913e17019 Update versions in instructions for manual set-up.
Georg Brandl <georg@python.org>
parents: 50269
diff changeset
81 svn co http://svn.python.org/projects/external/docutils-0.5/docutils tools/docutils
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
82
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
83 or by installing it from http://docutils.sf.net/.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
84
53457
172913e17019 Update versions in instructions for manual set-up.
Georg Brandl <georg@python.org>
parents: 50269
diff changeset
85 You also need Jinja2, either by checking it out via ::
172913e17019 Update versions in instructions for manual set-up.
Georg Brandl <georg@python.org>
parents: 50269
diff changeset
86
172913e17019 Update versions in instructions for manual set-up.
Georg Brandl <georg@python.org>
parents: 50269
diff changeset
87 svn co http://svn.python.org/projects/external/Jinja-2.1.1/jinja2 tools/jinja2
172913e17019 Update versions in instructions for manual set-up.
Georg Brandl <georg@python.org>
parents: 50269
diff changeset
88
172913e17019 Update versions in instructions for manual set-up.
Georg Brandl <georg@python.org>
parents: 50269
diff changeset
89 or by installing it from PyPI.
172913e17019 Update versions in instructions for manual set-up.
Georg Brandl <georg@python.org>
parents: 50269
diff changeset
90
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
91 You can optionally also install Pygments, either as a checkout via ::
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
92
53457
172913e17019 Update versions in instructions for manual set-up.
Georg Brandl <georg@python.org>
parents: 50269
diff changeset
93 svn co http://svn.python.org/projects/external/Pygments-0.11.1/pygments tools/pygments
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
94
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
95 or from PyPI at http://pypi.python.org/pypi/Pygments.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
96
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
97
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
98 Then, make an output directory, e.g. under `build/`, and run ::
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
99
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
100 python tools/sphinx-build.py -b<builder> . build/<outputdirectory>
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
101
50251
3ab102d9cf56 sphinx.web is long gone
Benjamin Peterson <benjamin@python.org>
parents: 49250
diff changeset
102 where `<builder>` is one of html, text, latex, or htmlhelp (for explanations see
3ab102d9cf56 sphinx.web is long gone
Benjamin Peterson <benjamin@python.org>
parents: 49250
diff changeset
103 the make targets above).
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
104
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
105
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
106 Contributing
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
107 ============
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
108
50252
af56e3f14eb7 update readme
Benjamin Peterson <benjamin@python.org>
parents: 50251
diff changeset
109 Bugs in the content should be reported to the Python bug tracker at
af56e3f14eb7 update readme
Benjamin Peterson <benjamin@python.org>
parents: 50251
diff changeset
110 http://bugs.python.org.
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
111
50252
af56e3f14eb7 update readme
Benjamin Peterson <benjamin@python.org>
parents: 50251
diff changeset
112 Bugs in the toolset should be reported in the Sphinx bug tracker at
af56e3f14eb7 update readme
Benjamin Peterson <benjamin@python.org>
parents: 50251
diff changeset
113 http://www.bitbucket.org/birkenfeld/sphinx/issues/.
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
114
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
115 You can also send a mail to the Python Documentation Team at docs@python.org,
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
116 and we will process your request as soon as possible.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
117
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
118 If you want to help the Documentation Team, you are always welcome. Just send
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
119 a mail to docs@python.org.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
120
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
121
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
122 Copyright notice
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
123 ================
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
124
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
125 The Python source is copyrighted, but you can freely use and copy it
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
126 as long as you don't change or remove the copyright notice:
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
127
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
128 ----------------------------------------------------------------------
45590
2d0bd095c420 More copyright year and version number bumps
Barry Warsaw <barry@python.org>
parents: 45472
diff changeset
129 Copyright (c) 2000-2008 Python Software Foundation.
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
130 All rights reserved.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
131
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
132 Copyright (c) 2000 BeOpen.com.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
133 All rights reserved.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
134
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
135 Copyright (c) 1995-2000 Corporation for National Research Initiatives.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
136 All rights reserved.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
137
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
138 Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
139 All rights reserved.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
140
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
141 See the file "license.rst" for information on usage and redistribution
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
142 of this file, and for a DISCLAIMER OF ALL WARRANTIES.
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
143 ----------------------------------------------------------------------