blob: 0391e5585fda019b30c6ee4f85371e846357ab8f [file] [log] [blame]
Guido van Rossumcd7bf391992-04-05 15:06:03 +00001Python main documentation -- in LaTeX
2-------------------------------------
3
4This directory contains the LaTeX sources to the Python documentation
5and a published article about Python.
Guido van Rossum7f777ed1990-08-09 14:25:15 +00006
Guido van Rossum676d6da1992-02-11 15:51:36 +00007The following are the LaTeX source files:
Guido van Rossum7f777ed1990-08-09 14:25:15 +00008
Guido van Rossum676d6da1992-02-11 15:51:36 +00009 tut.tex The tutorial
Guido van Rossumddfb3eb1991-11-12 15:40:23 +000010 lib.tex, lib[1-5].tex The library reference
Guido van Rossum676d6da1992-02-11 15:51:36 +000011 ref.tex The reference manual
12 qua.tex, quabib.bib Article published in CWI Quarterly
Guido van Rossum7f777ed1990-08-09 14:25:15 +000013
Guido van Rossum676d6da1992-02-11 15:51:36 +000014All except qua.tex use the style option file "myformat.sty". This
Guido van Rossumcd7bf391992-04-05 15:06:03 +000015contains some macro definitions and sets some style parameters.
Guido van Rossum7f777ed1990-08-09 14:25:15 +000016
Guido van Rossumcd7bf391992-04-05 15:06:03 +000017All documents are set up for European paper size ("A4": 21 x 29.7 cm)
18by default. To use US paper, remove the "a4wide" style option from
19the \documentstyle options list in the first line of the main .tex
20files (you may want to fiddle with the lay-out parameters, since the
21default format uses rather wide margins to my taste).
22
23You need the makeindex utility to produce the index for ref.tex
24lib.tex; you need bibtex to produce the references list for qua.tex.
25
26There's a Makefile to call latex and the other utilities in the right
27order and the right number of times. This will produce dvi files for
28each document made; to preview them, use xdvi. Printing depends on
29local conventions; at my site, I use dvips and lpr. For example:
Guido van Rossum7f777ed1990-08-09 14:25:15 +000030
Guido van Rossum0e5f0091992-03-06 10:56:17 +000031 make ref # creates ref.dvi
32 xdvi ref # preview it
33 dvips -Ppsc ref | lpr -Ppsc # print it on printer "psc".
Guido van Rossumcd7bf391992-04-05 15:06:03 +000034
35If you don't have latex, you can ftp the pre-formatted PosytScript
36versions of the documents; see "../misc/FTP" for information about
37ftp-ing Python files.