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

Skip to content

Commit f1245a8

Browse files
committed
adapted to modern times; added section of HTML
1 parent 73827c6 commit f1245a8

1 file changed

Lines changed: 39 additions & 21 deletions

File tree

Doc/README

Lines changed: 39 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ 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+
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
9+
fetched the main Python distribution, in a file named
10+
"pythondoc-ps<version>.tar.gz". (See "../Misc/FAQ" for more
11+
information about ftp-ing Python files.)
12+
713
The following are the LaTeX source files:
814

915
tut.tex The tutorial
@@ -25,38 +31,50 @@ may want to fiddle with lay-out parameters like \textwidth and
2531
You need the makeindex utility to produce the index for ref.tex
2632
lib.tex; you need bibtex to produce the references list for qua.tex.
2733

28-
There's a Makefile to call latex and the other utilities in the right
29-
order and the right number of times. This will produce dvi files for
30-
each document made; to preview them, use xdvi. Printing depends on
31-
local conventions; at my site, I use dvips and lpr. For example:
34+
There's a Makefile to call LaTeX and the other utilities in the right
35+
order and the right number of times. This will produce DVI files for
36+
each document made; to preview them, use xdvi. PostScript is produced
37+
by the same Makefile target that produces the DVI files. This uses
38+
the dvips tool. Printing depends on local conventions; at my site, I
39+
use lpr. For example:
40+
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".
44+
45+
46+
Making HTML files
47+
-----------------
3248

33-
make ref # creates ref.dvi
34-
xdvi ref # preview it
35-
dvips -Ppsc ref | lpr -Ppsc # print it on printer "psc".
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.
3652

37-
If you don't have latex, you can ftp the pre-formatted PosytScript
38-
versions of the documents. It should be in the same place where you
39-
fetched the main Python distribution, if you got it by ftp. (See
40-
"../Misc/FAQ" for information about ftp-ing Python files.)
53+
The Library manual doesn't work well with LaTeX2HTML; instead, there's
54+
a Python script texi2html.py in this directory that can be run on the
55+
texinfo generated as an intermediate step for generating the INFO
56+
files as described in the next section. The command "make libwww"
57+
should do this.
4158

4259

4360
Making the INFO version of the Library Reference
4461
------------------------------------------------
4562

46-
The Library Reference can now also be read in hypertext form using the
63+
The Library Reference can also be read in hypertext form using the
4764
Emacs INFO system. This uses Texinfo format as an intermediate step.
4865
It requires texinfo version 2 (we have used 2.14).
4966

5067
To build the info files (python-lib.info*), say "make lib.info". This
51-
takes a while, even on machines with 33 MIPS and 16 Mbytes :-) You can
52-
ignore the output.
53-
54-
But first you'll have to change a site dependency in fix.el: if
55-
texinfo 2.xx isn't installed by default at your site, you'll have to
56-
install it (use archie to locate a version and ftp to fetch it). If
57-
you can't install it in the standard Emacs load path, uncomment the
58-
line containing a "(setq load-path ...)" statement, and fill in the
59-
path where you put it.
68+
takes a while, even on a machine with a 100 MHz clock and 64 Mbytes of
69+
RAM :-). Please ignore the output, which appears like error messages
70+
but really is debugging output only.
71+
72+
You may have to change a site dependency in fix.el: if texinfo 2.xx
73+
isn't installed by default at your site, you'll have to install it
74+
(use archie to locate a version and ftp to fetch it). If you can't
75+
install it in the standard Emacs load path, uncomment the line
76+
containing a "(setq load-path ...)" statement, and fill in the path
77+
where you put it.
6078

6179
The files used by the conversion process are:
6280

0 commit comments

Comments
 (0)