cpython/Doc/README

38 lines
1.5 KiB
Plaintext
Raw Normal View History

1992-04-05 15:06:03 +00:00
Python main documentation -- in LaTeX
-------------------------------------
This directory contains the LaTeX sources to the Python documentation
and a published article about Python.
1991-01-25 13:29:53 +00:00
The following are the LaTeX source files:
1991-01-25 13:29:53 +00:00
tut.tex The tutorial
1991-11-12 15:40:23 +00:00
lib.tex, lib[1-5].tex The library reference
ref.tex The reference manual
qua.tex, quabib.bib Article published in CWI Quarterly
1991-01-25 13:29:53 +00:00
All except qua.tex use the style option file "myformat.sty". This
1992-04-05 15:06:03 +00:00
contains some macro definitions and sets some style parameters.
1992-04-06 14:02:37 +00:00
The style parameters are set up for European paper size (21 x 29.7 cm,
a.k.a. A4, or roughly 8.27 x 11.7 inch) by default. To use US paper,
comment out the line saying \input{a4wide.sty} in myformat.sty (you
may want to fiddle with lay-out parameters like \textwidth and
\textheight, since the default format uses rather wide margins).
1992-03-06 10:56:17 +00:00
1992-04-05 15:06:03 +00:00
You need the makeindex utility to produce the index for ref.tex
lib.tex; you need bibtex to produce the references list for qua.tex.
There's a Makefile to call latex and the other utilities in the right
order and the right number of times. This will produce dvi files for
each document made; to preview them, use xdvi. Printing depends on
local conventions; at my site, I use dvips and lpr. For example:
1992-03-06 10:56:17 +00:00
make ref # creates ref.dvi
xdvi ref # preview it
dvips -Ppsc ref | lpr -Ppsc # print it on printer "psc".
1992-04-05 15:06:03 +00:00
If you don't have latex, you can ftp the pre-formatted PosytScript
versions of the documents; see "../misc/FTP" for information about
ftp-ing Python files.