Mercurial > cpython-lru_cache-weakref

annotate Doc/README @ 5817:48b94de85bf3 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Extensive changes by AMK.
author Guido van Rossum <guido@python.org>
date Thu, 17 Jul 1997 16:29:42 +0000
parents 4de8b86ba255
children 9cf8d14f3565
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
4476
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
7 The Python Reference Manual is no longer maintained in LaTeX. It is
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
8 now a FrameMaker document. The FrameMaker 5.0 files (ref.book,
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
9 ref*.doc) as well as PostScript generated (ref.ps) from it are in the
4776
4de8b86ba255 Added pointer to framereader distribution.
Guido van Rossum <guido@python.org>
parents: 4476
diff changeset
10 subdirectory ref/. (See ftp://ftp.adobe.com/pub/adobe/framereader for
4de8b86ba255 Added pointer to framereader distribution.
Guido van Rossum <guido@python.org>
parents: 4476
diff changeset
11 a free reader for FrameMaker documents, for some platforms.)
4476
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
12
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
13 If you don't have LaTeX, you can ftp a tar file containing PostScript
4476
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
14 of the 3 main documents. It should be in the same place where you
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
15 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
16 "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
17 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
18
667
164b56fa6558 Added ref and qua; forget about the Makefile
Guido van Rossum <guido@python.org>
parents: 432
diff changeset
19 The following are the LaTeX source files:
0
3cd033e6b530 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
20
667
164b56fa6558 Added ref and qua; forget about the Makefile
Guido van Rossum <guido@python.org>
parents: 432
diff changeset
21 tut.tex The tutorial
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
22 lib.tex, lib*.tex The library reference
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
23 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
24 qua.tex, quabib.bib Article published in CWI Quarterly
0
3cd033e6b530 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
25
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
26 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
27 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
28 definitions and sets some style parameters.
796
136061840624 Made ready for release
Guido van Rossum <guido@python.org>
parents: 698
diff changeset
29
4476
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
30 You need the makeindex utility to produce the index for lib.tex; you
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
31 need bibtex to produce the references list for qua.tex.
796
136061840624 Made ready for release
Guido van Rossum <guido@python.org>
parents: 698
diff changeset
32
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
33 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
34 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
35 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
36 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
37 the dvips tool. Printing depends on local conventions; at my site, I
4476
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
38 use lp. For example:
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
39
4476
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
40 make lib # create lib.dvi and lib.ps
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
41 xdvi lib # preview lib.dvi
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
42 lp lib.ps # print on default printer
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
43
0
3cd033e6b530 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
44
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
45 Making HTML files
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
46 -----------------
796
136061840624 Made ready for release
Guido van Rossum <guido@python.org>
parents: 698
diff changeset
47
4476
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
48 The Tutorial and Extensions manual can be converted to HTML using
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
49 Nikos Drakos' LaTeX2HTML converter. See the Makefile; after some
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
50 twiddling, "make l2h" should do the trick.
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
51
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
52 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
53 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
54 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
55 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
56 should do this.
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
57
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
58
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
59 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
60 ------------------------------------------------
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
61
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
62 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
63 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
64 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
65
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
66 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
67 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
68 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
69 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
70
2583
7914915729e3 adapted to modern times; added section of HTML
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
71 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
72 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
73 (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
74 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
75 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
76 where you put it.
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
77
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
78 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
79
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
80 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
81 texi files.
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
82
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
83 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
84
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
85 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
86 '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
87 some cases.
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
88
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
89 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
90 "underscore hack". {\ptt \char'137} is
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
91 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
92 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
93
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
94 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
95 to be processed.
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 804
diff changeset
96
4476
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
97 Thanks for Jan-Hein B\"uhrman for writing and debugging the convertor
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
98 and related scripts, and for fixing the LaTeX sources and writing new
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
99 macros for myformat.sty! More thanks to Dave Ascher for adapting
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
100 myformat.sty to the new LaTeX release, to Fred Drake for revamping the
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
101 partparse.py and texi2html.py scripts, to the many anonymous authors
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
102 of library manual sections and corrections (too many to mention).
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
103
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
104 Many thanks to Robin Friedrich for the conversion of the Reference
7e5f03953110 Adapted to migration of reference manual to Frame.
Guido van Rossum <guido@python.org>
parents: 2583
diff changeset
105 Manual to FrameMaker and his work on its index.