annotate Doc/Makefile @ 5817:48b94de85bf3 legacy-trunk

Extensive changes by AMK.
author Guido van Rossum <guido@python.org>
date Thu, 17 Jul 1997 16:29:42 +0000
parents d8a4f0d9221f
children ed5db0c2a3f3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
1 # Makefile for Python documentation
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
2 # ---------------------------------
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
3 #
2582
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
4 # See also the README file.
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
5 #
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
6 # This is a bit of a mess. The main documents are:
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
7 # tut -- Tutorial (file tut.tex)
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
8 # lib -- Library Reference (file lib.tex, inputs lib*.tex)
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
9 # ext -- Extending and Embedding (file ext.tex)
5536
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
10 # api -- Python-C API Reference
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
11 #
4453
dcc4cf9fa62a Removed LaTeX version of reference manual. Added ref/ref.ps.
Guido van Rossum <guido@python.org>
parents: 4435
diff changeset
12 # The Reference Manual is now maintained as a FrameMaker document.
dcc4cf9fa62a Removed LaTeX version of reference manual. Added ref/ref.ps.
Guido van Rossum <guido@python.org>
parents: 4435
diff changeset
13 # See the subdirectory ref; PostScript is included as ref/ref.ps.
dcc4cf9fa62a Removed LaTeX version of reference manual. Added ref/ref.ps.
Guido van Rossum <guido@python.org>
parents: 4435
diff changeset
14 # (In the future, the Tutorial will also be converted to FrameMaker;
dcc4cf9fa62a Removed LaTeX version of reference manual. Added ref/ref.ps.
Guido van Rossum <guido@python.org>
parents: 4435
diff changeset
15 # the other documents will be maintained in a text format such
dcc4cf9fa62a Removed LaTeX version of reference manual. Added ref/ref.ps.
Guido van Rossum <guido@python.org>
parents: 4435
diff changeset
16 # as LaTeX or perhaps TIM.)
dcc4cf9fa62a Removed LaTeX version of reference manual. Added ref/ref.ps.
Guido van Rossum <guido@python.org>
parents: 4435
diff changeset
17 #
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
18 # The main target "make all" creates DVI and PostScript for these
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
19 # four. You can also do "make lib" (etc.) to process individual
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
20 # documents.
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
21 #
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
22 # There's one local style file: myformat.sty. This defines a number
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
23 # of macros that are similar in name and intent as macros in Texinfo
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
24 # (e.g. \code{...} and \emph{...}), as well as a number of
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
25 # environments for formatting function and data definitions, also in
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
26 # the style of Texinfo.
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
27 #
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
28 # Everything is processed by LaTeX. The following tools are used:
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
29 # latex
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
30 # makeindex
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
31 # dvips
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
32 #
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
33 # There's a problem with generating the index which has been solved by
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
34 # a sed command applied to the index file. The shell script fix_hack
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
35 # does this (the Makefile takes care of calling it).
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
36 #
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
37 # To preview the dvi files produced by LaTeX it would be useful to
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
38 # have xdvi as well.
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
39 #
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
40 # Additional targets attempt to convert selected LaTeX sources to
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
41 # various other formats. These are generally site specific because
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
42 # the tools used are all but universal. These targets are:
5536
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
43 # l2h -- convert tut, lib, ext, api from LaTeX to HTML
2582
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
44 # See the README file for more info on these targets.
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
45
2582
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
46 # Customizations -- you *may* have to edit these
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
47
2582
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
48 # Where are the various programs?
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
49 LATEX= latex
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
50 BIBTEX= bibtex
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
51 DVIPS= dvips -f
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
52 MAKEINDEX= makeindex
4512
23a104d3bced (Makefile): Updated latex2html support.
Fred Drake <fdrake@acm.org>
parents: 4453
diff changeset
53 L2H= latex2html
4539
47e7c42b9dc6 (Makefile): Updated comments about using LaTeX2HTML for the library
Fred Drake <fdrake@acm.org>
parents: 4512
diff changeset
54 L2HARGS= -address $$USER@`domainname`
2582
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
55
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
56 # Install destination -- not used now but might be useful some time...
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
57 DESTDIR= /usr/local
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
58 LIBDESTDIR= $DESTDIR/lib
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
59 LIBDEST= $LIBDESTDIR/python
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
60 DOCDESTDIR= $LIBDEST/doc
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
61
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
62 # Ideally, you shouldn't need to edit beyond this point
910
a4f2b2210b02 > * Makefile: always create .ps files; add qua to 'all' target;
Guido van Rossum <guido@python.org>
parents: 903
diff changeset
63
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
64 # Main target
3997
8069790b3974 Separate .dvi and .ps targets.
Guido van Rossum <guido@python.org>
parents: 3199
diff changeset
65 all: all-ps
8069790b3974 Separate .dvi and .ps targets.
Guido van Rossum <guido@python.org>
parents: 3199
diff changeset
66
5536
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
67 all-dvi: tut.dvi lib.dvi ext.dvi api.dvi
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
68 all-ps: tut.ps lib.ps ext.ps api.ps
700
14119b1948fb Much simpler version, intended as a script.
Guido van Rossum <guido@python.org>
parents: 447
diff changeset
69
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
70 # Individual document fake targets
3997
8069790b3974 Separate .dvi and .ps targets.
Guido van Rossum <guido@python.org>
parents: 3199
diff changeset
71 tut: tut.ps
8069790b3974 Separate .dvi and .ps targets.
Guido van Rossum <guido@python.org>
parents: 3199
diff changeset
72 lib: lib.ps
8069790b3974 Separate .dvi and .ps targets.
Guido van Rossum <guido@python.org>
parents: 3199
diff changeset
73 ext: ext.ps
5536
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
74 api: api.ps
1767
907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs)
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
75
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
76 # Dependencies
5536
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
77 tut.dvi lib.dvi ext.dvi api.dvi: myformat.sty fix_hack
1767
907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs)
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
78
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
79 # Tutorial document
1767
907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs)
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
80 tut.dvi: tut.tex
2582
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
81 $(LATEX) tut
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
82 $(LATEX) tut
3997
8069790b3974 Separate .dvi and .ps targets.
Guido van Rossum <guido@python.org>
parents: 3199
diff changeset
83
8069790b3974 Separate .dvi and .ps targets.
Guido van Rossum <guido@python.org>
parents: 3199
diff changeset
84 tut.ps: tut.dvi
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1426
diff changeset
85 $(DVIPS) tut >tut.ps
134
5d5c9b2da562 Took out (di)troff references.
Guido van Rossum <guido@python.org>
parents: 123
diff changeset
86
1767
907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs)
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
87 # LaTeX source files for the Python Library Reference
907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs)
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
88 LIBFILES = lib.tex \
4047
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
89 libintro.tex libobjs.tex libtypes.tex libexcs.tex libfuncs.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
90 libpython.tex libsys.tex libtypes2.tex libtraceback.tex libpickle.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
91 libshelve.tex libcopy.tex libmarshal.tex libimp.tex libparser.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
92 libbltin.tex libmain.tex libstrings.tex libstring.tex libregex.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
93 libregsub.tex libstruct.tex libmisc.tex libmath.tex librand.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
94 libwhrandom.tex libarray.tex liballos.tex libos.tex libtime.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
95 libgetopt.tex libtempfile.tex liberrno.tex libsomeos.tex libsignal.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
96 libsocket.tex libselect.tex libthread.tex libunix.tex libposix.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
97 libppath.tex libpwd.tex libgrp.tex libcrypt.tex libdbm.tex libgdbm.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
98 libtermios.tex libfcntl.tex libposixfile.tex libsyslog.tex libpdb.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
99 libprofile.tex libwww.tex libcgi.tex liburllib.tex libhttplib.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
100 libftplib.tex libgopherlib.tex libnntplib.tex liburlparse.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
101 libhtmllib.tex libsgmllib.tex librfc822.tex libmimetools.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
102 libbinascii.tex libmm.tex libaudioop.tex libimageop.tex libaifc.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
103 libjpeg.tex librgbimg.tex libcrypto.tex libmd5.tex libmpz.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
104 librotor.tex libmac.tex libctb.tex libmacconsole.tex libmacdnr.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
105 libmacfs.tex libmacos.tex libmacostools.tex libmactcp.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
106 libmacspeech.tex libmacui.tex libstdwin.tex libsgi.tex libal.tex \
3e6863cea383 Added imghdr,xdrlib; reformatted Makefile somewhat
Guido van Rossum <guido@python.org>
parents: 3997
diff changeset
107 libcd.tex libfl.tex libfm.tex libgl.tex libimgfile.tex libsun.tex \
4435
25c53286763d Added chapter on restricted execution.
Guido van Rossum <guido@python.org>
parents: 4393
diff changeset
108 libxdrlib.tex libimghdr.tex \
25c53286763d Added chapter on restricted execution.
Guido van Rossum <guido@python.org>
parents: 4393
diff changeset
109 librestricted.tex librexec.tex libbastion.tex \
4844
555f6e76d207 Added libstat.tex
Guido van Rossum <guido@python.org>
parents: 4769
diff changeset
110 libformatter.tex liboperator.tex libsoundex.tex libresource.tex \
5220
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents: 5218
diff changeset
111 libstat.tex libstrio.tex libundoc.tex libmailcap.tex libglob.tex \
5344
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents: 5261
diff changeset
112 libuser.tex libanydbm.tex librandom.tex libsite.tex libwhichdb.tex \
5690
4e817b2ad991 add libmailbox
Guido van Rossum <guido@python.org>
parents: 5548
diff changeset
113 libbase64.tex libfnmatch.tex libquopri.tex libzlib.tex libsocksvr.tex \
5815
d8a4f0d9221f Added libni.tex libgzip.tex
Guido van Rossum <guido@python.org>
parents: 5811
diff changeset
114 libmailbox.tex libcommands.tex libcmath.tex libni.tex libgzip.tex
1767
907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs)
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
115
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
116 # Library document
1767
907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs)
Guido van Rossum <guido@python.org>
parents: 1751
diff changeset
117 lib.dvi: $(LIBFILES)
700
14119b1948fb Much simpler version, intended as a script.
Guido van Rossum <guido@python.org>
parents: 447
diff changeset
118 touch lib.ind
2582
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
119 $(LATEX) lib
1100
ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion.
Guido van Rossum <guido@python.org>
parents: 910
diff changeset
120 ./fix_hack lib.idx
4539
47e7c42b9dc6 (Makefile): Updated comments about using LaTeX2HTML for the library
Fred Drake <fdrake@acm.org>
parents: 4512
diff changeset
121 $(MAKEINDEX) lib.idx
2582
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
122 $(LATEX) lib
3997
8069790b3974 Separate .dvi and .ps targets.
Guido van Rossum <guido@python.org>
parents: 3199
diff changeset
123
8069790b3974 Separate .dvi and .ps targets.
Guido van Rossum <guido@python.org>
parents: 3199
diff changeset
124 lib.ps: lib.dvi
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1426
diff changeset
125 $(DVIPS) lib >lib.ps
0
3cd033e6b530 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
126
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
127 # Extensions document
5536
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
128 ext.dvi: ext.tex
1401
cd5989a58bcf * ext.tex: documentation for extending, reference counts, and embedding
Guido van Rossum <guido@python.org>
parents: 1283
diff changeset
129 touch ext.ind
2582
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
130 $(LATEX) ext
1401
cd5989a58bcf * ext.tex: documentation for extending, reference counts, and embedding
Guido van Rossum <guido@python.org>
parents: 1283
diff changeset
131 ./fix_hack ext.idx
4539
47e7c42b9dc6 (Makefile): Updated comments about using LaTeX2HTML for the library
Fred Drake <fdrake@acm.org>
parents: 4512
diff changeset
132 $(MAKEINDEX) ext.idx
2582
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
133 $(LATEX) ext
3997
8069790b3974 Separate .dvi and .ps targets.
Guido van Rossum <guido@python.org>
parents: 3199
diff changeset
134
8069790b3974 Separate .dvi and .ps targets.
Guido van Rossum <guido@python.org>
parents: 3199
diff changeset
135 ext.ps: ext.dvi
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1426
diff changeset
136 $(DVIPS) ext >ext.ps
1401
cd5989a58bcf * ext.tex: documentation for extending, reference counts, and embedding
Guido van Rossum <guido@python.org>
parents: 1283
diff changeset
137
5536
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
138 # Python-C API document
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
139 api.dvi: api.tex
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
140 touch api.ind
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
141 $(LATEX) api
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
142 ./fix_hack api.idx
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
143 $(MAKEINDEX) api.idx
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
144 $(LATEX) api
3997
8069790b3974 Separate .dvi and .ps targets.
Guido van Rossum <guido@python.org>
parents: 3199
diff changeset
145
5536
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
146 api.ps: api.dvi
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
147 $(DVIPS) api >api.ps
123
22727b43781e Made the move to TeX.
Guido van Rossum <guido@python.org>
parents: 3
diff changeset
148
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
149
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
150 # The remaining part of the Makefile is concerned with various
2582
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
151 # conversions, as described above. See also the README file.
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
152
2582
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
153 # Targets to convert the manuals to HTML using Nikos Drakos' LaTeX to
3770e4347803 use macros more; added some more docs
Guido van Rossum <guido@python.org>
parents: 2574
diff changeset
154 # HTML converter. For more info on this program, see
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
155 # <URL:http://cbl.leeds.ac.uk/nikos/tex2html/doc/latex2html/latex2html.html>.
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1426
diff changeset
156
4539
47e7c42b9dc6 (Makefile): Updated comments about using LaTeX2HTML for the library
Fred Drake <fdrake@acm.org>
parents: 4512
diff changeset
157 # Note that LaTeX2HTML inserts references to an "icons" directory in
47e7c42b9dc6 (Makefile): Updated comments about using LaTeX2HTML for the library
Fred Drake <fdrake@acm.org>
parents: 4512
diff changeset
158 # each page that it generates. You can customize where these icons
47e7c42b9dc6 (Makefile): Updated comments about using LaTeX2HTML for the library
Fred Drake <fdrake@acm.org>
parents: 4512
diff changeset
159 # are to be found; I generally make it point to "../icons" and then
47e7c42b9dc6 (Makefile): Updated comments about using LaTeX2HTML for the library
Fred Drake <fdrake@acm.org>
parents: 4512
diff changeset
160 # create a symbolic link to the icons directory in the LaTeX2HTML
47e7c42b9dc6 (Makefile): Updated comments about using LaTeX2HTML for the library
Fred Drake <fdrake@acm.org>
parents: 4512
diff changeset
161 # source at the appropriate place. Change the definition of
47e7c42b9dc6 (Makefile): Updated comments about using LaTeX2HTML for the library
Fred Drake <fdrake@acm.org>
parents: 4512
diff changeset
162 # $ICONSERVER in .latex2html-init to point to a different location.
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
163
4604
2368353d9887 (Makefile): The sed hack is needed for all 3 manuals processed by latex2html;
Fred Drake <fdrake@acm.org>
parents: 4603
diff changeset
164 # The sed hack rips out a superfluous comma which I haven't found the source
2368353d9887 (Makefile): The sed hack is needed for all 3 manuals processed by latex2html;
Fred Drake <fdrake@acm.org>
parents: 4603
diff changeset
165 # of; the prominent location makes it worth the extra step. This affects the
2368353d9887 (Makefile): The sed hack is needed for all 3 manuals processed by latex2html;
Fred Drake <fdrake@acm.org>
parents: 4603
diff changeset
166 # title pages!
2368353d9887 (Makefile): The sed hack is needed for all 3 manuals processed by latex2html;
Fred Drake <fdrake@acm.org>
parents: 4603
diff changeset
167
5536
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
168 l2h: l2htut l2hext l2hlib l2htut
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1426
diff changeset
169
4539
47e7c42b9dc6 (Makefile): Updated comments about using LaTeX2HTML for the library
Fred Drake <fdrake@acm.org>
parents: 4512
diff changeset
170 l2htut: tut.dvi myformat.perl
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1426
diff changeset
171 $(L2H) $(L2HARGS) tut.tex
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1426
diff changeset
172 @rm -rf python-tut
4604
2368353d9887 (Makefile): The sed hack is needed for all 3 manuals processed by latex2html;
Fred Drake <fdrake@acm.org>
parents: 4603
diff changeset
173 sed 's/^<P CLASS=ABSTRACT>,/<P CLASS=ABSTRACT>/' \
2368353d9887 (Makefile): The sed hack is needed for all 3 manuals processed by latex2html;
Fred Drake <fdrake@acm.org>
parents: 4603
diff changeset
174 <tut/tut.html >tut/xxx
2368353d9887 (Makefile): The sed hack is needed for all 3 manuals processed by latex2html;
Fred Drake <fdrake@acm.org>
parents: 4603
diff changeset
175 mv tut/xxx tut/tut.html
4605
b98b46dd4367 (Makefile): Added sym links for each manual, i.e., index.html -> lib.html.
Fred Drake <fdrake@acm.org>
parents: 4604
diff changeset
176 ln -s tut.html tut/index.html
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1426
diff changeset
177 mv tut python-tut
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1426
diff changeset
178
4539
47e7c42b9dc6 (Makefile): Updated comments about using LaTeX2HTML for the library
Fred Drake <fdrake@acm.org>
parents: 4512
diff changeset
179 l2hext: ext.dvi myformat.perl
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1426
diff changeset
180 $(L2H) $(L2HARGS) ext.tex
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1426
diff changeset
181 @rm -rf python-ext
4604
2368353d9887 (Makefile): The sed hack is needed for all 3 manuals processed by latex2html;
Fred Drake <fdrake@acm.org>
parents: 4603
diff changeset
182 sed 's/^<P CLASS=ABSTRACT>,/<P CLASS=ABSTRACT>/' \
2368353d9887 (Makefile): The sed hack is needed for all 3 manuals processed by latex2html;
Fred Drake <fdrake@acm.org>
parents: 4603
diff changeset
183 <ext/ext.html >ext/xxx
4605
b98b46dd4367 (Makefile): Added sym links for each manual, i.e., index.html -> lib.html.
Fred Drake <fdrake@acm.org>
parents: 4604
diff changeset
184 ln -s ext.html ext/index.html
4604
2368353d9887 (Makefile): The sed hack is needed for all 3 manuals processed by latex2html;
Fred Drake <fdrake@acm.org>
parents: 4603
diff changeset
185 mv ext/xxx ext/ext.html
1751
ec25aad43724 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1426
diff changeset
186 mv ext python-ext
1236
680406c41539 * Changed preface in texipre.dat.
Guido van Rossum <guido@python.org>
parents: 1195
diff changeset
187
4539
47e7c42b9dc6 (Makefile): Updated comments about using LaTeX2HTML for the library
Fred Drake <fdrake@acm.org>
parents: 4512
diff changeset
188 l2hlib: lib.dvi myformat.perl
47e7c42b9dc6 (Makefile): Updated comments about using LaTeX2HTML for the library
Fred Drake <fdrake@acm.org>
parents: 4512
diff changeset
189 ./fix_libaux.sed <lib.aux >@lib.aux
47e7c42b9dc6 (Makefile): Updated comments about using LaTeX2HTML for the library
Fred Drake <fdrake@acm.org>
parents: 4512
diff changeset
190 mv @lib.aux lib.aux
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
191 $(L2H) $(L2HARGS) lib.tex
4603
5c741d2d97f5 (Makefile): Rip out old partparse.py / texi2html.py stuff -- use latex2html
Fred Drake <fdrake@acm.org>
parents: 4539
diff changeset
192 sed 's/^<P CLASS=ABSTRACT>,/<P CLASS=ABSTRACT>/' \
5c741d2d97f5 (Makefile): Rip out old partparse.py / texi2html.py stuff -- use latex2html
Fred Drake <fdrake@acm.org>
parents: 4539
diff changeset
193 <lib/lib.html >lib/xxx
5c741d2d97f5 (Makefile): Rip out old partparse.py / texi2html.py stuff -- use latex2html
Fred Drake <fdrake@acm.org>
parents: 4539
diff changeset
194 mv lib/xxx lib/lib.html
4605
b98b46dd4367 (Makefile): Added sym links for each manual, i.e., index.html -> lib.html.
Fred Drake <fdrake@acm.org>
parents: 4604
diff changeset
195 ln -s lib.html lib/index.html
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
196 @rm -rf python-lib
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
197 mv lib python-lib
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
198
5536
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
199 l2hapi: api.dvi myformat.perl
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
200 $(L2H) $(L2HARGS) api.tex
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
201 @rm -rf python-api
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
202 sed 's/^<P CLASS=ABSTRACT>,/<P CLASS=ABSTRACT>/' \
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
203 <api/api.html >api/xxx
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
204 ln -s api.html api/index.html
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
205 mv api/xxx api/api.html
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
206 mv api python-api
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
207
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
208
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
209 # Housekeeping targets
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
210
5536
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
211 # Remove temporary files; all except the following:
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
212 # - sources: .tex, .bib, .sty
c6f04e965508 Made a start with api.tex, the Python-C API Reference Manual.
Guido van Rossum <guido@python.org>
parents: 5391
diff changeset
213 # - useful results: .dvi, .ps, .texi, .info
0
3cd033e6b530 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
214 clean:
1141
54eb2cf2697e Changes to some math using underscore as subscript, necessary since
Guido van Rossum <guido@python.org>
parents: 1100
diff changeset
215 rm -f @* *~ *.aux *.idx *.ilg *.ind *.log *.toc *.blg *.bbl *.pyc
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
216 rm -f *.bak *.orig
910
a4f2b2210b02 > * Makefile: always create .ps files; add qua to 'all' target;
Guido van Rossum <guido@python.org>
parents: 903
diff changeset
217
2574
f0b7872da689 added lots of comments
Guido van Rossum <guido@python.org>
parents: 2489
diff changeset
218 # Remove temporaries as well as final products
910
a4f2b2210b02 > * Makefile: always create .ps files; add qua to 'all' target;
Guido van Rossum <guido@python.org>
parents: 903
diff changeset
219 clobber: clean
1401
cd5989a58bcf * ext.tex: documentation for extending, reference counts, and embedding
Guido van Rossum <guido@python.org>
parents: 1283
diff changeset
220 rm -f *.dvi *.ps *.texi *.info *.info-[0-9]*