blob: c0556bdc42534c6af8b716b67a802fd7798603d7 [file] [log] [blame]
Guido van Rossume83e3801995-03-17 16:01:35 +00001# Makefile for Python documentation
2# ---------------------------------
3#
Guido van Rossum73827c61995-03-20 13:00:32 +00004# See also the README file.
5#
Guido van Rossume83e3801995-03-17 16:01:35 +00006# This is a bit of a mess. The main documents are:
7# tut -- Tutorial (file tut.tex)
8# lib -- Library Reference (file lib.tex, inputs lib*.tex)
9# ref -- Language Reference (file ref.tex, inputs ref*.tex)
10# ext -- Extending and Embedding (file ext.tex)
11#
12# The main target "make all" creates DVI and PostScript for these
13# four. You can also do "make lib" (etc.) to process individual
14# documents.
15#
16# There's also:
17# qua -- Paper published in the CWI Quarterly (file qua.tex)
18#
19# There's one local style file: myformat.sty. This defines a number
20# of macros that are similar in name and intent as macros in Texinfo
21# (e.g. \code{...} and \emph{...}), as well as a number of
22# environments for formatting function and data definitions, also in
23# the style of Texinfo.
24#
25# Everything is processed by LaTeX. The following tools are used:
26# latex
27# makeindex
28# dvips
29# bibtex (only for formatting qua.tex)
30#
31# There's a problem with generating the index which has been solved by
32# a sed command applied to the index file. The shell script fix_hack
33# does this (the Makefile takes care of calling it).
34#
35# To preview the dvi files produced by LaTeX it would be useful to
36# have xdvi as well.
37#
38# Additional targets attempt to convert selected LaTeX sources to
39# various other formats. These are generally site specific because
40# the tools used are all but universal. These targets are:
41# l2h -- convert tut, ref, ext (but not lib!) from LaTeX to HTML
42# lib.texi -- convert lib from LaTeX to Texinfo
43# lib.info -- convert lib from Texinfo to Emacs INFO
44# libwww -- convert lib from Texinfo to HTML
Guido van Rossum73827c61995-03-20 13:00:32 +000045# See the README file for more info on these targets.
Guido van Rossume83e3801995-03-17 16:01:35 +000046
Guido van Rossum73827c61995-03-20 13:00:32 +000047# Customizations -- you *may* have to edit these
Guido van Rossume83e3801995-03-17 16:01:35 +000048
Guido van Rossum73827c61995-03-20 13:00:32 +000049# Where are the various programs?
50LATEX= latex
51BIBTEX= bibtex
52EMACS= emacs
53DVIPS= dvips -f
54MAKEINDEX= makeindex
55PYTHON= python
56MAKEINFO= makeinfo
57L2H= /ufs/guido/l2h/latex2html
58L2HARGS= -address $$USER@`domainname` -dont_include myformat
59
Guido van Rossumeb8d5031996-08-09 21:46:05 +000060# Destination directory for output of libwww target.
Fred Drakea39a25e1996-09-13 14:44:34 +000061PARTPARSE= $(PYTHON) ./partparse.pyc
62TEXI2HTML= $(PYTHON) ./texi2html.pyc
Guido van Rossumeb8d5031996-08-09 21:46:05 +000063LIBHTMLDIR= ./python-lib
64
Guido van Rossum73827c61995-03-20 13:00:32 +000065# Install destination -- not used now but might be useful some time...
66DESTDIR= /usr/local
67LIBDESTDIR= $DESTDIR/lib
68LIBDEST= $LIBDESTDIR/python
69DOCDESTDIR= $LIBDEST/doc
70
71# Ideally, you shouldn't need to edit beyond this point
Guido van Rossum5b343731992-07-07 09:06:34 +000072
Guido van Rossume83e3801995-03-17 16:01:35 +000073# Main target
Guido van Rossumeb8d5031996-08-09 21:46:05 +000074all: all-ps
75
76all-dvi: tut.dvi lib.dvi ref.dvi ext.dvi
77all-ps: tut.ps lib.ps ref.ps ext.ps
Guido van Rossum20aca5a1991-01-25 13:29:04 +000078
Guido van Rossume83e3801995-03-17 16:01:35 +000079# Individual document fake targets
Guido van Rossumeb8d5031996-08-09 21:46:05 +000080tut: tut.ps
81lib: lib.ps
82ref: ref.ps
83ext: ext.ps
Guido van Rossum16d6e711994-08-08 12:30:22 +000084
Guido van Rossume83e3801995-03-17 16:01:35 +000085# CWI Quarterly document fake target
Guido van Rossumeb8d5031996-08-09 21:46:05 +000086qua: qua.ps
Guido van Rossume83e3801995-03-17 16:01:35 +000087
88# Dependencies
Guido van Rossum16d6e711994-08-08 12:30:22 +000089tut.dvi lib.dvi ref.dvi ext.dvi: myformat.sty fix_hack
90
Guido van Rossume83e3801995-03-17 16:01:35 +000091# Tutorial document
Guido van Rossum16d6e711994-08-08 12:30:22 +000092tut.dvi: tut.tex
Guido van Rossum73827c61995-03-20 13:00:32 +000093 $(LATEX) tut
94 $(LATEX) tut
Guido van Rossumeb8d5031996-08-09 21:46:05 +000095
96tut.ps: tut.dvi
Guido van Rossum6938f061994-08-01 12:22:53 +000097 $(DVIPS) tut >tut.ps
Guido van Rossumb3fa13c1991-01-22 11:47:14 +000098
Guido van Rossume83e3801995-03-17 16:01:35 +000099# Reference document
Guido van Rossum16d6e711994-08-08 12:30:22 +0000100ref.dvi: ref.tex ref1.tex ref2.tex ref3.tex ref4.tex ref5.tex ref6.tex \
101 ref7.tex ref8.tex
Guido van Rossumb83241c1992-03-06 10:56:42 +0000102 touch ref.ind
Guido van Rossum73827c61995-03-20 13:00:32 +0000103 $(LATEX) ref
Guido van Rossum4ac605e1992-12-17 15:31:02 +0000104 ./fix_hack ref.idx
Guido van Rossum73827c61995-03-20 13:00:32 +0000105 $(MAKEINDEX) ref
106 $(LATEX) ref
Guido van Rossumeb8d5031996-08-09 21:46:05 +0000107
108ref.ps: ref.dvi
Guido van Rossum6938f061994-08-01 12:22:53 +0000109 $(DVIPS) ref >ref.ps
Guido van Rossumb3fa13c1991-01-22 11:47:14 +0000110
Guido van Rossum16d6e711994-08-08 12:30:22 +0000111# LaTeX source files for the Python Library Reference
112LIBFILES = lib.tex \
Guido van Rossum40006cf1996-08-19 22:58:03 +0000113 libintro.tex libobjs.tex libtypes.tex libexcs.tex libfuncs.tex \
114 libpython.tex libsys.tex libtypes2.tex libtraceback.tex libpickle.tex \
115 libshelve.tex libcopy.tex libmarshal.tex libimp.tex libparser.tex \
116 libbltin.tex libmain.tex libstrings.tex libstring.tex libregex.tex \
117 libregsub.tex libstruct.tex libmisc.tex libmath.tex librand.tex \
118 libwhrandom.tex libarray.tex liballos.tex libos.tex libtime.tex \
119 libgetopt.tex libtempfile.tex liberrno.tex libsomeos.tex libsignal.tex \
120 libsocket.tex libselect.tex libthread.tex libunix.tex libposix.tex \
121 libppath.tex libpwd.tex libgrp.tex libcrypt.tex libdbm.tex libgdbm.tex \
122 libtermios.tex libfcntl.tex libposixfile.tex libsyslog.tex libpdb.tex \
123 libprofile.tex libwww.tex libcgi.tex liburllib.tex libhttplib.tex \
124 libftplib.tex libgopherlib.tex libnntplib.tex liburlparse.tex \
125 libhtmllib.tex libsgmllib.tex librfc822.tex libmimetools.tex \
126 libbinascii.tex libmm.tex libaudioop.tex libimageop.tex libaifc.tex \
127 libjpeg.tex librgbimg.tex libcrypto.tex libmd5.tex libmpz.tex \
128 librotor.tex libmac.tex libctb.tex libmacconsole.tex libmacdnr.tex \
129 libmacfs.tex libmacos.tex libmacostools.tex libmactcp.tex \
130 libmacspeech.tex libmacui.tex libstdwin.tex libsgi.tex libal.tex \
131 libcd.tex libfl.tex libfm.tex libgl.tex libimgfile.tex libsun.tex \
Fred Drake0b95abc1996-10-09 16:15:06 +0000132 libxdrlib.tex libimghdr.tex librexec.tex libbastion.tex libformatter.tex
Guido van Rossum16d6e711994-08-08 12:30:22 +0000133
Guido van Rossume83e3801995-03-17 16:01:35 +0000134# Library document
Guido van Rossum16d6e711994-08-08 12:30:22 +0000135lib.dvi: $(LIBFILES)
Guido van Rossumb83241c1992-03-06 10:56:42 +0000136 touch lib.ind
Guido van Rossum73827c61995-03-20 13:00:32 +0000137 $(LATEX) lib
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000138 ./fix_hack lib.idx
Guido van Rossum73827c61995-03-20 13:00:32 +0000139 $(MAKEINDEX) lib
140 $(LATEX) lib
Guido van Rossumeb8d5031996-08-09 21:46:05 +0000141
142lib.ps: lib.dvi
Guido van Rossum6938f061994-08-01 12:22:53 +0000143 $(DVIPS) lib >lib.ps
Guido van Rossuma52117e1991-11-21 13:54:36 +0000144
Guido van Rossume83e3801995-03-17 16:01:35 +0000145# Extensions document
Guido van Rossumf8daa4f1996-08-23 15:33:51 +0000146ext.dvi: ext.tex extref.tex
Guido van Rossum7a2dba21993-11-05 14:45:11 +0000147 touch ext.ind
Guido van Rossum73827c61995-03-20 13:00:32 +0000148 $(LATEX) ext
Guido van Rossum7a2dba21993-11-05 14:45:11 +0000149 ./fix_hack ext.idx
Guido van Rossum73827c61995-03-20 13:00:32 +0000150 $(MAKEINDEX) ext
151 $(LATEX) ext
Guido van Rossumeb8d5031996-08-09 21:46:05 +0000152
153ext.ps: ext.dvi
Guido van Rossum6938f061994-08-01 12:22:53 +0000154 $(DVIPS) ext >ext.ps
Guido van Rossum7a2dba21993-11-05 14:45:11 +0000155
Guido van Rossume83e3801995-03-17 16:01:35 +0000156# Quarterly document
Guido van Rossum16d6e711994-08-08 12:30:22 +0000157qua.dvi: qua.tex quabib.bib
Guido van Rossum73827c61995-03-20 13:00:32 +0000158 $(LATEX) qua
159 $(BIBTEX) qua
160 $(LATEX) qua
161 $(BIBTEX) qua
Guido van Rossumeb8d5031996-08-09 21:46:05 +0000162
163qua.ps: qua.dvi
Guido van Rossum6938f061994-08-01 12:22:53 +0000164 $(DVIPS) qua >qua.ps
Guido van Rossumb3fa13c1991-01-22 11:47:14 +0000165
Guido van Rossume83e3801995-03-17 16:01:35 +0000166
167# The remaining part of the Makefile is concerned with various
Guido van Rossum73827c61995-03-20 13:00:32 +0000168# conversions, as described above. See also the README file.
Guido van Rossume83e3801995-03-17 16:01:35 +0000169
Fred Drakea39a25e1996-09-13 14:44:34 +0000170.SUFFIXES: .py .pyc
171
172.py.pyc:
173 $(PYTHON) -c "import $*"
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000174
Guido van Rossum7a2dba21993-11-05 14:45:11 +0000175.PRECIOUS: lib.texi
176
Fred Drakea39a25e1996-09-13 14:44:34 +0000177lib.texi: lib*.tex texipre.dat texipost.dat partparse.pyc fix.el
178 $(PARTPARSE) -o @lib.texi `./whichlibs`
179 $(EMACS) -batch -l fix.el -f save-buffer -kill
180 mv @lib.texi lib.texi
181
Guido van Rossum6938f061994-08-01 12:22:53 +0000182python-lib.info: lib.texi
Guido van Rossum73827c61995-03-20 13:00:32 +0000183 -$(MAKEINFO) --footnote-style end --fill-column 72 \
184 --paragraph-indent 0 lib.texi
Guido van Rossum7a2dba21993-11-05 14:45:11 +0000185
186lib.info: python-lib.info
187
Fred Drakea39a25e1996-09-13 14:44:34 +0000188libwww: lib.texi texi2html.pyc
Guido van Rossumeb8d5031996-08-09 21:46:05 +0000189 if test ! -d $(LIBHTMLDIR); then mkdir $(LIBHTMLDIR); else true; fi
Fred Drakea39a25e1996-09-13 14:44:34 +0000190 $(TEXI2HTML) -d lib.texi $(LIBHTMLDIR)
Guido van Rossum6938f061994-08-01 12:22:53 +0000191
Guido van Rossum73827c61995-03-20 13:00:32 +0000192# Targets to convert the manuals to HTML using Nikos Drakos' LaTeX to
193# HTML converter. For more info on this program, see
Guido van Rossume83e3801995-03-17 16:01:35 +0000194# <URL:http://cbl.leeds.ac.uk/nikos/tex2html/doc/latex2html/latex2html.html>.
195# (I've had some trouble getting this to work with the netpbm version
196# of the pbmplus library; ppmtogif dumped core because giftopnm
197# outputs bitmap (pbm) files. I've fixed this by changing the source
198# of LaTeX2HTML to insert a call to pnmtoppm, which I wrote myself.
199# You can probably also use "pbmtopgm | pgmtoppm"...
200
201# In order to use these targets, you must edit the definition of L2H
Guido van Rossum73827c61995-03-20 13:00:32 +0000202# earlier in the Makefile to point to the latex2html program. Note
203# that LaTeX2HTML inserts references to an "icons" directory in each
204# page that it generates. You can customize where these icons are to
205# be found; I generally make it point to "../icons" and then create a
Guido van Rossume83e3801995-03-17 16:01:35 +0000206# symbolic link to the icons directory in the LaTeX2HTML source at the
207# appropriate place.
208
Guido van Rossum6938f061994-08-01 12:22:53 +0000209l2h: l2htut l2href l2hext
210
Guido van Rossumf8daa4f1996-08-23 15:33:51 +0000211l2htut: tut.dvi
Guido van Rossum6938f061994-08-01 12:22:53 +0000212 $(L2H) $(L2HARGS) tut.tex
213 @rm -rf python-tut
214 mv tut python-tut
215
Guido van Rossumf8daa4f1996-08-23 15:33:51 +0000216l2href: ref.dvi
Guido van Rossum6938f061994-08-01 12:22:53 +0000217 $(L2H) $(L2HARGS) ref.tex
218 @rm -rf python-ref
219 mv ref python-ref
220
Guido van Rossumf8daa4f1996-08-23 15:33:51 +0000221l2hext: ext.dvi
Guido van Rossum6938f061994-08-01 12:22:53 +0000222 $(L2H) $(L2HARGS) ext.tex
223 @rm -rf python-ext
224 mv ext python-ext
Guido van Rossum970871f1993-02-21 20:10:26 +0000225
Guido van Rossume83e3801995-03-17 16:01:35 +0000226# This target doesn't quite work, since l2h doesn't understand the
227# funcdesc and similar environments, and turns them into GIF images.
228# Use the "libwww" target above instead.
Guido van Rossumf8daa4f1996-08-23 15:33:51 +0000229l2hlib: lib.dvi
Guido van Rossume83e3801995-03-17 16:01:35 +0000230 $(L2H) $(L2HARGS) lib.tex
231 @rm -rf python-lib
232 mv lib python-lib
233
234
235# Housekeeping targets
236
237# Remove temporary files
Guido van Rossum7f777ed1990-08-09 14:25:15 +0000238clean:
Guido van Rossum4ac605e1992-12-17 15:31:02 +0000239 rm -f @* *~ *.aux *.idx *.ilg *.ind *.log *.toc *.blg *.bbl *.pyc
Guido van Rossume83e3801995-03-17 16:01:35 +0000240 rm -f *.bak *.orig
Guido van Rossum5b343731992-07-07 09:06:34 +0000241 # Sources: .tex, .bib, .sty
Guido van Rossum7a2dba21993-11-05 14:45:11 +0000242 # Useful results: .dvi, .ps, .texi, .info
Guido van Rossum5b343731992-07-07 09:06:34 +0000243
Guido van Rossume83e3801995-03-17 16:01:35 +0000244# Remove temporaries as well as final products
Guido van Rossum5b343731992-07-07 09:06:34 +0000245clobber: clean
Guido van Rossum7a2dba21993-11-05 14:45:11 +0000246 rm -f *.dvi *.ps *.texi *.info *.info-[0-9]*