Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 71ec03b

Browse files
committed
Adapted to migration of reference manual to Frame.
1 parent 1775a51 commit 71ec03b

1 file changed

Lines changed: 24 additions & 20 deletions

File tree

Doc/README

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,13 @@ Python main documentation -- in LaTeX
44
This directory contains the LaTeX sources to the Python documentation
55
and a published article about Python.
66

7+
The Python Reference Manual is no longer maintained in LaTeX. It is
8+
now a FrameMaker document. The FrameMaker 5.0 files (ref.book,
9+
ref*.doc) as well as PostScript generated (ref.ps) from it are in the
10+
subdirectory ref/.
11+
712
If you don't have LaTeX, you can ftp a tar file containing PostScript
8-
of the 4 main documents. It should be in the same place where you
13+
of the 3 main documents. It should be in the same place where you
914
fetched the main Python distribution, in a file named
1015
"pythondoc-ps<version>.tar.gz". (See "../Misc/FAQ" for more
1116
information about ftp-ing Python files.)
@@ -14,41 +19,34 @@ The following are the LaTeX source files:
1419

1520
tut.tex The tutorial
1621
lib.tex, lib*.tex The library reference
17-
ref.tex, ref[1-8].tex The reference manual
1822
ext.tex How to extend Python
1923
qua.tex, quabib.bib Article published in CWI Quarterly
2024

2125
All except qua.tex (which isn't built by the default target) use the
2226
style option file "myformat.sty". This contains some macro
2327
definitions and sets some style parameters.
2428

25-
The style parameters are set up for European paper size (21 x 29.7 cm,
26-
a.k.a. A4, or roughly 8.27 x 11.7 inch) by default. To use US paper,
27-
comment out the line saying \input{a4wide.sty} in myformat.sty (you
28-
may want to fiddle with lay-out parameters like \textwidth and
29-
\textheight, since the default format uses rather wide margins).
30-
31-
You need the makeindex utility to produce the index for ref.tex
32-
lib.tex; you need bibtex to produce the references list for qua.tex.
29+
You need the makeindex utility to produce the index for lib.tex; you
30+
need bibtex to produce the references list for qua.tex.
3331

3432
There's a Makefile to call LaTeX and the other utilities in the right
3533
order and the right number of times. This will produce DVI files for
3634
each document made; to preview them, use xdvi. PostScript is produced
3735
by the same Makefile target that produces the DVI files. This uses
3836
the dvips tool. Printing depends on local conventions; at my site, I
39-
use lpr. For example:
37+
use lp. For example:
4038

41-
make ref # creates ref.dvi and ref.ps
42-
xdvi ref # preview it ref.dvi
43-
lpr -Ppsc ref.ps # print it on printer "psc".
39+
make lib # create lib.dvi and lib.ps
40+
xdvi lib # preview lib.dvi
41+
lp lib.ps # print on default printer
4442

4543

4644
Making HTML files
4745
-----------------
4846

49-
The Reference, Tutorial and Extensions manual can all be converted to
50-
HTML using Nikos Drakos' LaTeX2HTML converter. See the Makefile;
51-
after some twiddling, "make l2h" should do the trick.
47+
The Tutorial and Extensions manual can be converted to HTML using
48+
Nikos Drakos' LaTeX2HTML converter. See the Makefile; after some
49+
twiddling, "make l2h" should do the trick.
5250

5351
The Library manual doesn't work well with LaTeX2HTML; instead, there's
5452
a Python script texi2html.py in this directory that can be run on the
@@ -95,6 +93,12 @@ fix_hack Shell script to fix the results of the
9593
whichlibs Shell script to print a list of lib*.tex files
9694
to be processed.
9795

98-
A Million thanks for Jan-Hein B\"uhrman for writing and debugging the
99-
convertor and related scripts, and for fixing the LaTeX sources and
100-
writing new macros for myformat.sty!
96+
Thanks for Jan-Hein B\"uhrman for writing and debugging the convertor
97+
and related scripts, and for fixing the LaTeX sources and writing new
98+
macros for myformat.sty! More thanks to Dave Ascher for adapting
99+
myformat.sty to the new LaTeX release, to Fred Drake for revamping the
100+
partparse.py and texi2html.py scripts, to the many anonymous authors
101+
of library manual sections and corrections (too many to mention).
102+
103+
Many thanks to Robin Friedrich for the conversion of the Reference
104+
Manual to FrameMaker and his work on its index.

0 commit comments

Comments
 (0)