Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 1 | # Makefile for Python documentation |
| 2 | # --------------------------------- |
| 3 | # |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 4 | # See also the README file. |
| 5 | # |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 6 | # 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) |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 9 | # ext -- Extending and Embedding (file ext.tex) |
Guido van Rossum | 9231c8f | 1997-05-15 21:43:21 +0000 | [diff] [blame] | 10 | # api -- Python-C API Reference |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 11 | # |
Guido van Rossum | 1f17543 | 1996-10-22 20:00:02 +0000 | [diff] [blame] | 12 | # The Reference Manual is now maintained as a FrameMaker document. |
| 13 | # See the subdirectory ref; PostScript is included as ref/ref.ps. |
| 14 | # (In the future, the Tutorial will also be converted to FrameMaker; |
| 15 | # the other documents will be maintained in a text format such |
| 16 | # as LaTeX or perhaps TIM.) |
| 17 | # |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 18 | # The main target "make all" creates DVI and PostScript for these |
| 19 | # four. You can also do "make lib" (etc.) to process individual |
| 20 | # documents. |
| 21 | # |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 22 | # There's one local style file: myformat.sty. This defines a number |
| 23 | # of macros that are similar in name and intent as macros in Texinfo |
| 24 | # (e.g. \code{...} and \emph{...}), as well as a number of |
| 25 | # environments for formatting function and data definitions, also in |
| 26 | # the style of Texinfo. |
| 27 | # |
| 28 | # Everything is processed by LaTeX. The following tools are used: |
| 29 | # latex |
| 30 | # makeindex |
| 31 | # dvips |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 32 | # |
| 33 | # There's a problem with generating the index which has been solved by |
| 34 | # a sed command applied to the index file. The shell script fix_hack |
| 35 | # does this (the Makefile takes care of calling it). |
| 36 | # |
| 37 | # To preview the dvi files produced by LaTeX it would be useful to |
| 38 | # have xdvi as well. |
| 39 | # |
| 40 | # Additional targets attempt to convert selected LaTeX sources to |
| 41 | # various other formats. These are generally site specific because |
| 42 | # the tools used are all but universal. These targets are: |
Guido van Rossum | 9231c8f | 1997-05-15 21:43:21 +0000 | [diff] [blame] | 43 | # l2h -- convert tut, lib, ext, api from LaTeX to HTML |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 44 | # See the README file for more info on these targets. |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 45 | |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 46 | # Customizations -- you *may* have to edit these |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 47 | |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 48 | # Where are the various programs? |
| 49 | LATEX= latex |
| 50 | BIBTEX= bibtex |
Guido van Rossum | 5344d4f | 1997-10-05 18:51:02 +0000 | [diff] [blame] | 51 | DVIPS= dvips -f -N0 |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 52 | MAKEINDEX= makeindex |
Fred Drake | f93f101 | 1996-10-29 16:07:46 +0000 | [diff] [blame] | 53 | L2H= latex2html |
Fred Drake | b4d4e25 | 1996-11-11 21:03:01 +0000 | [diff] [blame] | 54 | L2HARGS= -address $$USER@`domainname` |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 55 | |
| 56 | # Install destination -- not used now but might be useful some time... |
| 57 | DESTDIR= /usr/local |
| 58 | LIBDESTDIR= $DESTDIR/lib |
| 59 | LIBDEST= $LIBDESTDIR/python |
| 60 | DOCDESTDIR= $LIBDEST/doc |
| 61 | |
| 62 | # Ideally, you shouldn't need to edit beyond this point |
Guido van Rossum | 5b34373 | 1992-07-07 09:06:34 +0000 | [diff] [blame] | 63 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 64 | # Main target |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 65 | all: all-ps |
| 66 | |
Guido van Rossum | 9231c8f | 1997-05-15 21:43:21 +0000 | [diff] [blame] | 67 | all-dvi: tut.dvi lib.dvi ext.dvi api.dvi |
| 68 | all-ps: tut.ps lib.ps ext.ps api.ps |
Guido van Rossum | 20aca5a | 1991-01-25 13:29:04 +0000 | [diff] [blame] | 69 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 70 | # Individual document fake targets |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 71 | tut: tut.ps |
| 72 | lib: lib.ps |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 73 | ext: ext.ps |
Guido van Rossum | 9231c8f | 1997-05-15 21:43:21 +0000 | [diff] [blame] | 74 | api: api.ps |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 75 | |
| 76 | # Dependencies |
Guido van Rossum | 9231c8f | 1997-05-15 21:43:21 +0000 | [diff] [blame] | 77 | tut.dvi lib.dvi ext.dvi api.dvi: myformat.sty fix_hack |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 78 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 79 | # Tutorial document |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 80 | tut.dvi: tut.tex |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 81 | $(LATEX) tut |
| 82 | $(LATEX) tut |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 83 | |
| 84 | tut.ps: tut.dvi |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 85 | $(DVIPS) tut >tut.ps |
Guido van Rossum | b3fa13c | 1991-01-22 11:47:14 +0000 | [diff] [blame] | 86 | |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 87 | # LaTeX source files for the Python Library Reference |
| 88 | LIBFILES = lib.tex \ |
Guido van Rossum | 40006cf | 1996-08-19 22:58:03 +0000 | [diff] [blame] | 89 | libintro.tex libobjs.tex libtypes.tex libexcs.tex libfuncs.tex \ |
| 90 | libpython.tex libsys.tex libtypes2.tex libtraceback.tex libpickle.tex \ |
| 91 | libshelve.tex libcopy.tex libmarshal.tex libimp.tex libparser.tex \ |
| 92 | libbltin.tex libmain.tex libstrings.tex libstring.tex libregex.tex \ |
| 93 | libregsub.tex libstruct.tex libmisc.tex libmath.tex librand.tex \ |
| 94 | libwhrandom.tex libarray.tex liballos.tex libos.tex libtime.tex \ |
| 95 | libgetopt.tex libtempfile.tex liberrno.tex libsomeos.tex libsignal.tex \ |
| 96 | libsocket.tex libselect.tex libthread.tex libunix.tex libposix.tex \ |
| 97 | libppath.tex libpwd.tex libgrp.tex libcrypt.tex libdbm.tex libgdbm.tex \ |
| 98 | libtermios.tex libfcntl.tex libposixfile.tex libsyslog.tex libpdb.tex \ |
| 99 | libprofile.tex libwww.tex libcgi.tex liburllib.tex libhttplib.tex \ |
| 100 | libftplib.tex libgopherlib.tex libnntplib.tex liburlparse.tex \ |
| 101 | libhtmllib.tex libsgmllib.tex librfc822.tex libmimetools.tex \ |
| 102 | libbinascii.tex libmm.tex libaudioop.tex libimageop.tex libaifc.tex \ |
| 103 | libjpeg.tex librgbimg.tex libcrypto.tex libmd5.tex libmpz.tex \ |
| 104 | librotor.tex libmac.tex libctb.tex libmacconsole.tex libmacdnr.tex \ |
| 105 | libmacfs.tex libmacos.tex libmacostools.tex libmactcp.tex \ |
| 106 | libmacspeech.tex libmacui.tex libstdwin.tex libsgi.tex libal.tex \ |
| 107 | libcd.tex libfl.tex libfm.tex libgl.tex libimgfile.tex libsun.tex \ |
Guido van Rossum | a80c398 | 1996-10-22 01:12:13 +0000 | [diff] [blame] | 108 | libxdrlib.tex libimghdr.tex \ |
| 109 | librestricted.tex librexec.tex libbastion.tex \ |
Guido van Rossum | 3dd68d3 | 1996-12-31 02:24:54 +0000 | [diff] [blame] | 110 | libformatter.tex liboperator.tex libsoundex.tex libresource.tex \ |
Guido van Rossum | 7f3b042 | 1997-03-27 14:56:18 +0000 | [diff] [blame] | 111 | libstat.tex libstrio.tex libundoc.tex libmailcap.tex libglob.tex \ |
Guido van Rossum | e76b7a8 | 1997-04-27 21:25:52 +0000 | [diff] [blame] | 112 | libuser.tex libanydbm.tex librandom.tex libsite.tex libwhichdb.tex \ |
Guido van Rossum | 41c302f | 1997-06-02 17:36:12 +0000 | [diff] [blame] | 113 | libbase64.tex libfnmatch.tex libquopri.tex libzlib.tex libsocksvr.tex \ |
Fred Drake | 18600a4 | 1997-07-18 20:43:27 +0000 | [diff] [blame] | 114 | libmailbox.tex libcommands.tex libcmath.tex libni.tex libgzip.tex \ |
Guido van Rossum | 36764b8 | 1997-08-30 20:02:25 +0000 | [diff] [blame] | 115 | libpprint.tex libcode.tex libmimify.tex libre.tex libmacic.tex \ |
| 116 | libuserdict.tex |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 117 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 118 | # Library document |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 119 | lib.dvi: $(LIBFILES) |
Guido van Rossum | b83241c | 1992-03-06 10:56:42 +0000 | [diff] [blame] | 120 | touch lib.ind |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 121 | $(LATEX) lib |
Guido van Rossum | 95cd2ef | 1992-12-08 14:37:55 +0000 | [diff] [blame] | 122 | ./fix_hack lib.idx |
Fred Drake | b4d4e25 | 1996-11-11 21:03:01 +0000 | [diff] [blame] | 123 | $(MAKEINDEX) lib.idx |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 124 | $(LATEX) lib |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 125 | |
| 126 | lib.ps: lib.dvi |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 127 | $(DVIPS) lib >lib.ps |
Guido van Rossum | a52117e | 1991-11-21 13:54:36 +0000 | [diff] [blame] | 128 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 129 | # Extensions document |
Guido van Rossum | 9231c8f | 1997-05-15 21:43:21 +0000 | [diff] [blame] | 130 | ext.dvi: ext.tex |
Guido van Rossum | 7a2dba2 | 1993-11-05 14:45:11 +0000 | [diff] [blame] | 131 | touch ext.ind |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 132 | $(LATEX) ext |
Guido van Rossum | 7a2dba2 | 1993-11-05 14:45:11 +0000 | [diff] [blame] | 133 | ./fix_hack ext.idx |
Fred Drake | b4d4e25 | 1996-11-11 21:03:01 +0000 | [diff] [blame] | 134 | $(MAKEINDEX) ext.idx |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 135 | $(LATEX) ext |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 136 | |
| 137 | ext.ps: ext.dvi |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 138 | $(DVIPS) ext >ext.ps |
Guido van Rossum | 7a2dba2 | 1993-11-05 14:45:11 +0000 | [diff] [blame] | 139 | |
Guido van Rossum | 9231c8f | 1997-05-15 21:43:21 +0000 | [diff] [blame] | 140 | # Python-C API document |
| 141 | api.dvi: api.tex |
| 142 | touch api.ind |
| 143 | $(LATEX) api |
| 144 | ./fix_hack api.idx |
| 145 | $(MAKEINDEX) api.idx |
| 146 | $(LATEX) api |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 147 | |
Guido van Rossum | 9231c8f | 1997-05-15 21:43:21 +0000 | [diff] [blame] | 148 | api.ps: api.dvi |
| 149 | $(DVIPS) api >api.ps |
Guido van Rossum | b3fa13c | 1991-01-22 11:47:14 +0000 | [diff] [blame] | 150 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 151 | |
| 152 | # The remaining part of the Makefile is concerned with various |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 153 | # conversions, as described above. See also the README file. |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 154 | |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 155 | # Targets to convert the manuals to HTML using Nikos Drakos' LaTeX to |
| 156 | # HTML converter. For more info on this program, see |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 157 | # <URL:http://cbl.leeds.ac.uk/nikos/tex2html/doc/latex2html/latex2html.html>. |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 158 | |
Fred Drake | b4d4e25 | 1996-11-11 21:03:01 +0000 | [diff] [blame] | 159 | # Note that LaTeX2HTML inserts references to an "icons" directory in |
| 160 | # each page that it generates. You can customize where these icons |
| 161 | # are to be found; I generally make it point to "../icons" and then |
| 162 | # create a symbolic link to the icons directory in the LaTeX2HTML |
| 163 | # source at the appropriate place. Change the definition of |
| 164 | # $ICONSERVER in .latex2html-init to point to a different location. |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 165 | |
Fred Drake | fc8f6f3 | 1996-12-06 18:45:30 +0000 | [diff] [blame] | 166 | # The sed hack rips out a superfluous comma which I haven't found the source |
| 167 | # of; the prominent location makes it worth the extra step. This affects the |
| 168 | # title pages! |
| 169 | |
Fred Drake | bc0cd37 | 1997-07-30 15:59:25 +0000 | [diff] [blame] | 170 | l2h: l2htut l2hext l2hlib l2hapi |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 171 | |
Fred Drake | b4d4e25 | 1996-11-11 21:03:01 +0000 | [diff] [blame] | 172 | l2htut: tut.dvi myformat.perl |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 173 | $(L2H) $(L2HARGS) tut.tex |
Fred Drake | fc8f6f3 | 1996-12-06 18:45:30 +0000 | [diff] [blame] | 174 | sed 's/^<P CLASS=ABSTRACT>,/<P CLASS=ABSTRACT>/' \ |
| 175 | <tut/tut.html >tut/xxx |
| 176 | mv tut/xxx tut/tut.html |
Fred Drake | 03ff6f7 | 1997-08-22 18:18:54 +0000 | [diff] [blame] | 177 | ln -s tut.html tut/index.html || true |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 178 | |
Fred Drake | b4d4e25 | 1996-11-11 21:03:01 +0000 | [diff] [blame] | 179 | l2hext: ext.dvi myformat.perl |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 180 | $(L2H) $(L2HARGS) ext.tex |
Fred Drake | fc8f6f3 | 1996-12-06 18:45:30 +0000 | [diff] [blame] | 181 | sed 's/^<P CLASS=ABSTRACT>,/<P CLASS=ABSTRACT>/' \ |
| 182 | <ext/ext.html >ext/xxx |
| 183 | mv ext/xxx ext/ext.html |
Fred Drake | 03ff6f7 | 1997-08-22 18:18:54 +0000 | [diff] [blame] | 184 | ln -s ext.html ext/index.html || true |
Guido van Rossum | 970871f | 1993-02-21 20:10:26 +0000 | [diff] [blame] | 185 | |
Fred Drake | b4d4e25 | 1996-11-11 21:03:01 +0000 | [diff] [blame] | 186 | l2hlib: lib.dvi myformat.perl |
Fred Drake | 03ff6f7 | 1997-08-22 18:18:54 +0000 | [diff] [blame] | 187 | ./fix_libaux.sed <lib.aux >lib1.aux |
| 188 | mv lib1.aux lib.aux |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 189 | $(L2H) $(L2HARGS) lib.tex |
Fred Drake | f1e6707 | 1996-12-06 15:11:34 +0000 | [diff] [blame] | 190 | sed 's/^<P CLASS=ABSTRACT>,/<P CLASS=ABSTRACT>/' \ |
| 191 | <lib/lib.html >lib/xxx |
| 192 | mv lib/xxx lib/lib.html |
Fred Drake | 03ff6f7 | 1997-08-22 18:18:54 +0000 | [diff] [blame] | 193 | ln -s lib.html lib/index.html || true |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 194 | |
Guido van Rossum | 9231c8f | 1997-05-15 21:43:21 +0000 | [diff] [blame] | 195 | l2hapi: api.dvi myformat.perl |
| 196 | $(L2H) $(L2HARGS) api.tex |
Guido van Rossum | 9231c8f | 1997-05-15 21:43:21 +0000 | [diff] [blame] | 197 | sed 's/^<P CLASS=ABSTRACT>,/<P CLASS=ABSTRACT>/' \ |
| 198 | <api/api.html >api/xxx |
Guido van Rossum | 9231c8f | 1997-05-15 21:43:21 +0000 | [diff] [blame] | 199 | mv api/xxx api/api.html |
Fred Drake | 03ff6f7 | 1997-08-22 18:18:54 +0000 | [diff] [blame] | 200 | ln -s api.html api/index.html || true |
Guido van Rossum | 9231c8f | 1997-05-15 21:43:21 +0000 | [diff] [blame] | 201 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 202 | |
| 203 | # Housekeeping targets |
| 204 | |
Guido van Rossum | 9231c8f | 1997-05-15 21:43:21 +0000 | [diff] [blame] | 205 | # Remove temporary files; all except the following: |
| 206 | # - sources: .tex, .bib, .sty |
| 207 | # - useful results: .dvi, .ps, .texi, .info |
Fred Drake | 03ff6f7 | 1997-08-22 18:18:54 +0000 | [diff] [blame] | 208 | clean: l2hclean |
Guido van Rossum | 4ac605e | 1992-12-17 15:31:02 +0000 | [diff] [blame] | 209 | rm -f @* *~ *.aux *.idx *.ilg *.ind *.log *.toc *.blg *.bbl *.pyc |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 210 | rm -f *.bak *.orig |
Guido van Rossum | 5b34373 | 1992-07-07 09:06:34 +0000 | [diff] [blame] | 211 | |
Fred Drake | 03ff6f7 | 1997-08-22 18:18:54 +0000 | [diff] [blame] | 212 | l2hclean: |
Fred Drake | 5de31fc | 1997-08-22 18:20:33 +0000 | [diff] [blame] | 213 | rm -rf api ext lib tut |
Fred Drake | 03ff6f7 | 1997-08-22 18:18:54 +0000 | [diff] [blame] | 214 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 215 | # Remove temporaries as well as final products |
Guido van Rossum | 5b34373 | 1992-07-07 09:06:34 +0000 | [diff] [blame] | 216 | clobber: clean |
Guido van Rossum | 7a2dba2 | 1993-11-05 14:45:11 +0000 | [diff] [blame] | 217 | rm -f *.dvi *.ps *.texi *.info *.info-[0-9]* |