Mercurial > cpython-lru_cache-weakref

annotate Doc/README @ 3720:b341def4eef8 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Ignore latex intermediate products.
author Guido van Rossum <guido@python.org>
date Wed, 26 Jun 1996 19:30:01 +0000
parents 7914915729e3
children 7e5f03953110
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
796
136061840624 Made ready for release
Guido van Rossum <guido@python.org>
parents: 698
diff changeset
1 Python main documentation -- in LaTeX
136061840624 Made ready for release
Guido van Rossum <guido@python.org>
parents: 698
diff changeset
2 -------------------------------------
136061840624 Made ready for release
Guido van Rossum <guido@python.org>
parents: 698
diff changeset
3
136061840624 Made ready for release
Guido van Rossum <guido@python.org>
parents: 698
diff changeset
4 This directory contains the LaTeX sources to the Python documentation
136061840624 Made ready for release
Guido van Rossum <guido@python.org>
parents: 698
diff changeset
5 and a published article about Python.
667
164b56fa6558 Added ref and qua; forget about the Makefile
Guido van Rossum <guido@python.org>
parents: 432
diff changeset
6
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
7 If you don't have LaTeX, you can ftp a tar file containing PostScript
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
8 of the 4 main documents. It should be in the same place where you
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
9 fetched the main Python distribution, in a file named
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
10 "pythondoc-ps<version>.tar.gz". (See "../Misc/FAQ" for more
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
11 information about ftp-ing Python files.)
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
12
667
164b56fa6558 Added ref and qua; forget about the Makefile
Guido van Rossum <guido@python.org>
parents: 432
diff changeset
13 The following are the LaTeX source files:
0
3cd033e6b530 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
14
667
164b56fa6558 Added ref and qua; forget about the Makefile
Guido van Rossum <guido@python.org>
parents: 432
diff changeset
15 tut.tex The tutorial
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
16 lib.tex, lib*.tex The library reference
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
17 ref.tex, ref[1-8].tex The reference manual
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
18 ext.tex How to extend Python
667
164b56fa6558 Added ref and qua; forget about the Makefile
Guido van Rossum <guido@python.org>
parents: 432
diff changeset
19 qua.tex, quabib.bib Article published in CWI Quarterly
0
3cd033e6b530 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
20
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
21 All except qua.tex (which isn't built by the default target) use the
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
22 style option file "myformat.sty". This contains some macro
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
23 definitions and sets some style parameters.
796
136061840624 Made ready for release
Guido van Rossum <guido@python.org>
parents: 698
diff changeset
24
804
3adece2c8567 Change description of a4wide removal
Guido van Rossum <guido@python.org>
parents: 796
diff changeset
25 The style parameters are set up for European paper size (21 x 29.7 cm,
3adece2c8567 Change description of a4wide removal
Guido van Rossum <guido@python.org>
parents: 796
diff changeset
26 a.k.a. A4, or roughly 8.27 x 11.7 inch) by default. To use US paper,
3adece2c8567 Change description of a4wide removal
Guido van Rossum <guido@python.org>
parents: 796
diff changeset
27 comment out the line saying \input{a4wide.sty} in myformat.sty (you
3adece2c8567 Change description of a4wide removal
Guido van Rossum <guido@python.org>
parents: 796
diff changeset
28 may want to fiddle with lay-out parameters like \textwidth and
3adece2c8567 Change description of a4wide removal
Guido van Rossum <guido@python.org>
parents: 796
diff changeset
29 \textheight, since the default format uses rather wide margins).
667
164b56fa6558 Added ref and qua; forget about the Makefile
Guido van Rossum <guido@python.org>
parents: 432
diff changeset
30
796
136061840624 Made ready for release
Guido van Rossum <guido@python.org>
parents: 698
diff changeset
31 You need the makeindex utility to produce the index for ref.tex
136061840624 Made ready for release
Guido van Rossum <guido@python.org>
parents: 698
diff changeset
32 lib.tex; you need bibtex to produce the references list for qua.tex.
136061840624 Made ready for release
Guido van Rossum <guido@python.org>
parents: 698
diff changeset
33
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
34 There's a Makefile to call LaTeX and the other utilities in the right
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
35 order and the right number of times. This will produce DVI files for
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
36 each document made; to preview them, use xdvi. PostScript is produced
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
37 by the same Makefile target that produces the DVI files. This uses
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
38 the dvips tool. Printing depends on local conventions; at my site, I
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
39 use lpr. For example:
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
40
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
41 make ref # creates ref.dvi and ref.ps
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
42 xdvi ref # preview it ref.dvi
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
43 lpr -Ppsc ref.ps # print it on printer "psc".
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
44
0
3cd033e6b530 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
45
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
46 Making HTML files
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
47 -----------------
796
136061840624 Made ready for release
Guido van Rossum <guido@python.org>
parents: 698
diff changeset
48
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
49 The Reference, Tutorial and Extensions manual can all be converted to
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
50 HTML using Nikos Drakos' LaTeX2HTML converter. See the Makefile;
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
51 after some twiddling, "make l2h" should do the trick.
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
52
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
53 The Library manual doesn't work well with LaTeX2HTML; instead, there's
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
54 a Python script texi2html.py in this directory that can be run on the
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
55 texinfo generated as an intermediate step for generating the INFO
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
56 files as described in the next section. The command "make libwww"
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
57 should do this.
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
58
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
59
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
60 Making the INFO version of the Library Reference
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
61 ------------------------------------------------
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
62
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
63 The Library Reference can also be read in hypertext form using the
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
64 Emacs INFO system. This uses Texinfo format as an intermediate step.
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
65 It requires texinfo version 2 (we have used 2.14).
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
66
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
67 To build the info files (python-lib.info*), say "make lib.info". This
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
68 takes a while, even on a machine with a 100 MHz clock and 64 Mbytes of
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
69 RAM :-). Please ignore the output, which appears like error messages
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
70 but really is debugging output only.
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
71
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
72 You may have to change a site dependency in fix.el: if texinfo 2.xx
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
73 isn't installed by default at your site, you'll have to install it
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
74 (use archie to locate a version and ftp to fetch it). If you can't
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
75 install it in the standard Emacs load path, uncomment the line
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
76 containing a "(setq load-path ...)" statement, and fill in the path
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
77 where you put it.
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
78
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
79 The files used by the conversion process are:
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
80
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
81 partparse.py Python script that converts LaTeX sources to
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
82 texi files.
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
83
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
84 texi{pre,post}.dat Files placed before and after the result.
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
85
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
86 fix.el Elisp file executed by Emacs. Two calls to
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
87 'texinfo-all-menus-update are necessary in
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
88 some cases.
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
89
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
90 fix_hack Shell script to fix the results of the
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
91 "underscore hack". {\ptt \char'137} is
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
92 back-translated to a simple underscore. This
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
93 is needed for the texindex program.
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
94
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
95 whichlibs Shell script to print a list of lib*.tex files
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
96 to be processed.
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
97
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
98 A Million thanks for Jan-Hein B\"uhrman for writing and debugging the
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
99 convertor and related scripts, and for fixing the LaTeX sources and
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
100 writing new macros for myformat.sty!