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

Skip to content

Commit 099b76c

Browse files
freddrakefreddrake
committed
Changed some comments.... no longer mention FrameMaker.
1 parent ed3da23 commit 099b76c

1 file changed

Lines changed: 20 additions & 38 deletions

File tree

‎Doc/README‎

Lines changed: 20 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,6 @@ Python main documentation -- in LaTeX
44
This directory contains the LaTeX sources to the Python documentation.
55
They now require LaTeX2e (LaTeX 2.09 compatibility is dropped).
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/. (See <ftp://ftp.adobe.com/pub/adobe/framereader>
11-
for a free reader for FrameMaker documents, for some platforms.) Many
12-
thanks to Robin Friedrich for the conversion of the Reference Manual
13-
to FrameMaker and his work on its index.
14-
157
If you don't have LaTeX, or if you'd rather not format the
168
documentation yourself, you can ftp a tar file containing HTML, PDF,
179
or PostScript versions of all documents. Additional formats may be
@@ -21,10 +13,11 @@ main Python distribution (try <http://www.python.org> or
2113

2214
The following are the LaTeX source files:
2315

24-
tut.tex The tutorial
25-
lib.tex, lib*.tex The library reference
26-
ext.tex How to extend Python
27-
api.tex Reference for the Python/C API
16+
api/*.tex Python/C API Reference Manual
17+
ext/*.tex Extending and Embedding the Python Interpreter
18+
lib/*.tex Python Library Reference
19+
ref/*.tex Python Reference Manual
20+
tut/*.tex Python Tutorial
2821

2922
All use the "manual" document class and "python" package, derived from
3023
the old "myformat.sty" style file. These contains many macro
@@ -37,9 +30,9 @@ by the same Makefile target that produces the DVI files. This uses
3730
the dvips tool. Printing depends on local conventions; at our site,
3831
we use lpr. For example:
3932

40-
make lib # create lib.dvi and lib.ps
41-
xdvi lib # preview lib.dvi
42-
lpr lib.ps # print on default printer
33+
make lib # create lib.dvi and lib.ps
34+
xdvi lib # preview lib.dvi
35+
lpr lib.ps # print on default printer
4336

4437

4538
What if I find a bug?
@@ -67,15 +60,15 @@ You need to install Python; some of the scripts used to produce the
6760
documentation are written in Python.
6861

6962
The simplest way to get the rest of the tools in the configuration we
70-
used is to install the teTeX TeX distribution, version 0.9. More
63+
used is to install the teTeX TeX distribution, version 0.4 or 0.9. More
7164
information is available on teTeX at <http://www.tug.org/tetex/>.
7265
This is a UNIX-only TeX distribution at this time. Note that the 0.9
7366
release is still in testing; this documentation release was tested
74-
with the 18 Mar 1998 release. We'll be upgrading to the final version
75-
when it becomes available.
67+
with the 21 Apr 1998 release. We'll be upgrading to the final version
68+
when it becomes available. Except for the PDF generation, it also works
69+
with the (stable) teTeX 0.4 release.
7670

77-
If you don't want to get teTeX, or if you're not using UNIX, here is
78-
what you'll need:
71+
If you don't want to get teTeX, here is what you'll need:
7972

8073
To create DVI, PDF, or PostScript files:
8174

@@ -88,10 +81,9 @@ To create DVI, PDF, or PostScript files:
8881
To create PDF files:
8982

9083
- pdflatex. We used the one in the teTeX 0.9 distribution
91-
(version 0.12f at the time of this writing). Versions even
92-
a couple of patchlevels different are highly likely to
93-
fail due to syntax changes for some of the pdftex
94-
primitives.
84+
(version 0.12h at the time of this writing). Versions even
85+
a couple of patchlevels earlier are highly likely to fail
86+
due to syntax changes for some of the pdftex primitives.
9587

9688
To create PostScript files:
9789

@@ -136,15 +128,9 @@ file.
136128
What if I want to use A4 paper?
137129
-------------------------------
138130

139-
Edit the file texinputs/manual.cls. Change the line that reads:
140-
141-
\LoadClass[twoside,openright]{report}
142-
143-
to say:
144-
145-
\LoadClass[a4paper,twoside,openright]{report}
146-
147-
Now do a "make clean all" to generate PostScript files.
131+
Instead of building the PostScript by giving the command "make", give
132+
the command "make PAPER=a4"; the output will be produced in the
133+
paper-a4/ subdirectory.
148134

149135

150136
Making HTML files
@@ -154,18 +140,14 @@ The LaTeX documents can be converted to HTML using Nikos Drakos'
154140
LaTeX2HTML converter. See the Makefile; after some twiddling, "make
155141
l2h" should do the trick.
156142

157-
For the reference manual, we use Harlequin's webmaker. We're not very
158-
happy with it and hope that eventually FrameMaker will be able to
159-
produce HTML without third party help.
160-
161143

162144
What else is in here?
163145
---------------------
164146

165147
There is a new LaTeX document class called "howto". This is used for
166148
the new series of Python HOWTO documents which is being coordinated by
167149
Andrew Kuchling <[email protected]>. The file howto.tex is a commented
168-
template which may be used an example. A script to "do the right
150+
example which may be used a template. A script to "do the right
169151
thing" to format a howto document is included as tools/mkhowto.sh.
170152
Support for this document class is still new, but is expected to
171153
evolve rapidly. Use "mkhowto.sh --help" for information on using the

0 commit comments

Comments
 (0)