|
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.4 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 * "htmlhelp", which builds HTML files and a HTML Help project file usable to |
|
42 convert them into a single Compiled HTML (.chm) file -- these are popular |
|
43 under Microsoft Windows, but very handy on every platform. |
|
44 |
|
45 To create the CHM file, you need to run the Microsoft HTML Help Workshop |
|
46 over the generated project (.hhp) file. |
|
47 |
|
48 * "latex", which builds LaTeX source files that can be run with "pdflatex" |
|
49 to produce PDF documents. |
|
50 |
|
51 * "text", which builds a plain text file for each source file. |
|
52 |
|
53 * "linkcheck", which checks all external references to see whether they are |
|
54 broken, redirected or malformed, and outputs this information to stdout |
|
55 as well as a plain-text (.txt) file. |
|
56 |
|
57 * "changes", which builds an overview over all versionadded/versionchanged/ |
|
58 deprecated items in the current version. This is meant as a help for the |
|
59 writer of the "What's New" document. |
|
60 |
|
61 * "coverage", which builds a coverage overview for standard library modules |
|
62 and C API. |
|
63 |
|
64 * "pydoc-topics", which builds a Python module containing a dictionary |
|
65 with plain text documentation for the labels defined in |
|
66 `tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic |
|
67 and keyword help. |
|
68 |
|
69 A "make update" updates the Subversion checkouts in `tools/`. |
|
70 |
|
71 |
|
72 Without make |
|
73 ------------ |
|
74 |
|
75 You'll need to checkout the Sphinx package to the `tools/` directory:: |
|
76 |
|
77 svn co http://svn.python.org/projects/doctools/trunk/sphinx tools/sphinx |
|
78 |
|
79 Then, you need to install Docutils 0.4 (the SVN snapshot won't work), either |
|
80 by checking it out via :: |
|
81 |
|
82 svn co http://svn.python.org/projects/external/docutils-0.4/docutils tools/docutils |
|
83 |
|
84 or by installing it from http://docutils.sf.net/. |
|
85 |
|
86 You can optionally also install Pygments, either as a checkout via :: |
|
87 |
|
88 svn co http://svn.python.org/projects/external/Pygments-0.9/pygments tools/pygments |
|
89 |
|
90 or from PyPI at http://pypi.python.org/pypi/Pygments. |
|
91 |
|
92 |
|
93 Then, make an output directory, e.g. under `build/`, and run :: |
|
94 |
|
95 python tools/sphinx-build.py -b<builder> . build/<outputdirectory> |
|
96 |
|
97 where `<builder>` is one of html, web or htmlhelp (for explanations see the make |
|
98 targets above). |
|
99 |
|
100 |
|
101 Contributing |
|
102 ============ |
|
103 |
|
104 For bugs in the content, the online version at http://docs.python.org/ has a |
|
105 "suggest change" facility that can be used to correct errors in the source text |
|
106 and submit them as a patch to the maintainers. |
|
107 |
|
108 Bugs in the toolset should be reported in the Python bug tracker at |
|
109 http://bugs.python.org/. |
|
110 |
|
111 You can also send a mail to the Python Documentation Team at docs@python.org, |
|
112 and we will process your request as soon as possible. |
|
113 |
|
114 If you want to help the Documentation Team, you are always welcome. Just send |
|
115 a mail to docs@python.org. |
|
116 |
|
117 |
|
118 Copyright notice |
|
119 ================ |
|
120 |
|
121 The Python source is copyrighted, but you can freely use and copy it |
|
122 as long as you don't change or remove the copyright notice: |
|
123 |
|
124 ---------------------------------------------------------------------- |
|
125 Copyright (c) 2000-2008 Python Software Foundation. |
|
126 All rights reserved. |
|
127 |
|
128 Copyright (c) 2000 BeOpen.com. |
|
129 All rights reserved. |
|
130 |
|
131 Copyright (c) 1995-2000 Corporation for National Research Initiatives. |
|
132 All rights reserved. |
|
133 |
|
134 Copyright (c) 1991-1995 Stichting Mathematisch Centrum. |
|
135 All rights reserved. |
|
136 |
|
137 See the file "license.rst" for information on usage and redistribution |
|
138 of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
|
139 ---------------------------------------------------------------------- |