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) |
| 10 | # |
Guido van Rossum | 1f17543 | 1996-10-22 20:00:02 +0000 | [diff] [blame] | 11 | # The Reference Manual is now maintained as a FrameMaker document. |
| 12 | # See the subdirectory ref; PostScript is included as ref/ref.ps. |
| 13 | # (In the future, the Tutorial will also be converted to FrameMaker; |
| 14 | # the other documents will be maintained in a text format such |
| 15 | # as LaTeX or perhaps TIM.) |
| 16 | # |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 17 | # The main target "make all" creates DVI and PostScript for these |
| 18 | # four. You can also do "make lib" (etc.) to process individual |
| 19 | # documents. |
| 20 | # |
| 21 | # There's also: |
| 22 | # qua -- Paper published in the CWI Quarterly (file qua.tex) |
| 23 | # |
| 24 | # There's one local style file: myformat.sty. This defines a number |
| 25 | # of macros that are similar in name and intent as macros in Texinfo |
| 26 | # (e.g. \code{...} and \emph{...}), as well as a number of |
| 27 | # environments for formatting function and data definitions, also in |
| 28 | # the style of Texinfo. |
| 29 | # |
| 30 | # Everything is processed by LaTeX. The following tools are used: |
| 31 | # latex |
| 32 | # makeindex |
| 33 | # dvips |
| 34 | # bibtex (only for formatting qua.tex) |
| 35 | # |
| 36 | # There's a problem with generating the index which has been solved by |
| 37 | # a sed command applied to the index file. The shell script fix_hack |
| 38 | # does this (the Makefile takes care of calling it). |
| 39 | # |
| 40 | # To preview the dvi files produced by LaTeX it would be useful to |
| 41 | # have xdvi as well. |
| 42 | # |
| 43 | # Additional targets attempt to convert selected LaTeX sources to |
| 44 | # various other formats. These are generally site specific because |
| 45 | # the tools used are all but universal. These targets are: |
| 46 | # l2h -- convert tut, ref, ext (but not lib!) from LaTeX to HTML |
| 47 | # lib.texi -- convert lib from LaTeX to Texinfo |
| 48 | # lib.info -- convert lib from Texinfo to Emacs INFO |
| 49 | # libwww -- convert lib from Texinfo to HTML |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 50 | # See the README file for more info on these targets. |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 51 | |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 52 | # Customizations -- you *may* have to edit these |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 53 | |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 54 | # Where are the various programs? |
| 55 | LATEX= latex |
| 56 | BIBTEX= bibtex |
| 57 | EMACS= emacs |
| 58 | DVIPS= dvips -f |
| 59 | MAKEINDEX= makeindex |
| 60 | PYTHON= python |
| 61 | MAKEINFO= makeinfo |
Fred Drake | f93f101 | 1996-10-29 16:07:46 +0000 | [diff] [blame^] | 62 | L2H= latex2html |
| 63 | L2HARGS= -address $$USER@`domainname` -info "" |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 64 | |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 65 | # Destination directory for output of libwww target. |
Fred Drake | a39a25e | 1996-09-13 14:44:34 +0000 | [diff] [blame] | 66 | PARTPARSE= $(PYTHON) ./partparse.pyc |
Fred Drake | 5f2aa71 | 1996-10-09 19:33:17 +0000 | [diff] [blame] | 67 | TEXI2HTMLFLAGS= -d |
Fred Drake | a39a25e | 1996-09-13 14:44:34 +0000 | [diff] [blame] | 68 | TEXI2HTML= $(PYTHON) ./texi2html.pyc |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 69 | LIBHTMLDIR= ./python-lib |
| 70 | |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 71 | # Install destination -- not used now but might be useful some time... |
| 72 | DESTDIR= /usr/local |
| 73 | LIBDESTDIR= $DESTDIR/lib |
| 74 | LIBDEST= $LIBDESTDIR/python |
| 75 | DOCDESTDIR= $LIBDEST/doc |
| 76 | |
| 77 | # Ideally, you shouldn't need to edit beyond this point |
Guido van Rossum | 5b34373 | 1992-07-07 09:06:34 +0000 | [diff] [blame] | 78 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 79 | # Main target |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 80 | all: all-ps |
| 81 | |
Guido van Rossum | 1f17543 | 1996-10-22 20:00:02 +0000 | [diff] [blame] | 82 | all-dvi: tut.dvi lib.dvi ext.dvi |
| 83 | all-ps: tut.ps lib.ps ext.ps |
Guido van Rossum | 20aca5a | 1991-01-25 13:29:04 +0000 | [diff] [blame] | 84 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 85 | # Individual document fake targets |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 86 | tut: tut.ps |
| 87 | lib: lib.ps |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 88 | ext: ext.ps |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 89 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 90 | # CWI Quarterly document fake target |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 91 | qua: qua.ps |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 92 | |
| 93 | # Dependencies |
Guido van Rossum | 1f17543 | 1996-10-22 20:00:02 +0000 | [diff] [blame] | 94 | tut.dvi lib.dvi ext.dvi: myformat.sty fix_hack |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 95 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 96 | # Tutorial document |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 97 | tut.dvi: tut.tex |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 98 | $(LATEX) tut |
| 99 | $(LATEX) tut |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 100 | |
| 101 | tut.ps: tut.dvi |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 102 | $(DVIPS) tut >tut.ps |
Guido van Rossum | b3fa13c | 1991-01-22 11:47:14 +0000 | [diff] [blame] | 103 | |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 104 | # LaTeX source files for the Python Library Reference |
| 105 | LIBFILES = lib.tex \ |
Guido van Rossum | 40006cf | 1996-08-19 22:58:03 +0000 | [diff] [blame] | 106 | libintro.tex libobjs.tex libtypes.tex libexcs.tex libfuncs.tex \ |
| 107 | libpython.tex libsys.tex libtypes2.tex libtraceback.tex libpickle.tex \ |
| 108 | libshelve.tex libcopy.tex libmarshal.tex libimp.tex libparser.tex \ |
| 109 | libbltin.tex libmain.tex libstrings.tex libstring.tex libregex.tex \ |
| 110 | libregsub.tex libstruct.tex libmisc.tex libmath.tex librand.tex \ |
| 111 | libwhrandom.tex libarray.tex liballos.tex libos.tex libtime.tex \ |
| 112 | libgetopt.tex libtempfile.tex liberrno.tex libsomeos.tex libsignal.tex \ |
| 113 | libsocket.tex libselect.tex libthread.tex libunix.tex libposix.tex \ |
| 114 | libppath.tex libpwd.tex libgrp.tex libcrypt.tex libdbm.tex libgdbm.tex \ |
| 115 | libtermios.tex libfcntl.tex libposixfile.tex libsyslog.tex libpdb.tex \ |
| 116 | libprofile.tex libwww.tex libcgi.tex liburllib.tex libhttplib.tex \ |
| 117 | libftplib.tex libgopherlib.tex libnntplib.tex liburlparse.tex \ |
| 118 | libhtmllib.tex libsgmllib.tex librfc822.tex libmimetools.tex \ |
| 119 | libbinascii.tex libmm.tex libaudioop.tex libimageop.tex libaifc.tex \ |
| 120 | libjpeg.tex librgbimg.tex libcrypto.tex libmd5.tex libmpz.tex \ |
| 121 | librotor.tex libmac.tex libctb.tex libmacconsole.tex libmacdnr.tex \ |
| 122 | libmacfs.tex libmacos.tex libmacostools.tex libmactcp.tex \ |
| 123 | libmacspeech.tex libmacui.tex libstdwin.tex libsgi.tex libal.tex \ |
| 124 | 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] | 125 | libxdrlib.tex libimghdr.tex \ |
| 126 | librestricted.tex librexec.tex libbastion.tex \ |
| 127 | libformatter.tex |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 128 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 129 | # Library document |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 130 | lib.dvi: $(LIBFILES) |
Guido van Rossum | b83241c | 1992-03-06 10:56:42 +0000 | [diff] [blame] | 131 | touch lib.ind |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 132 | $(LATEX) lib |
Guido van Rossum | 95cd2ef | 1992-12-08 14:37:55 +0000 | [diff] [blame] | 133 | ./fix_hack lib.idx |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 134 | $(MAKEINDEX) lib |
| 135 | $(LATEX) lib |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 136 | |
| 137 | lib.ps: lib.dvi |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 138 | $(DVIPS) lib >lib.ps |
Guido van Rossum | a52117e | 1991-11-21 13:54:36 +0000 | [diff] [blame] | 139 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 140 | # Extensions document |
Guido van Rossum | f8daa4f | 1996-08-23 15:33:51 +0000 | [diff] [blame] | 141 | ext.dvi: ext.tex extref.tex |
Guido van Rossum | 7a2dba2 | 1993-11-05 14:45:11 +0000 | [diff] [blame] | 142 | touch ext.ind |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 143 | $(LATEX) ext |
Guido van Rossum | 7a2dba2 | 1993-11-05 14:45:11 +0000 | [diff] [blame] | 144 | ./fix_hack ext.idx |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 145 | $(MAKEINDEX) ext |
| 146 | $(LATEX) ext |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 147 | |
| 148 | ext.ps: ext.dvi |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 149 | $(DVIPS) ext >ext.ps |
Guido van Rossum | 7a2dba2 | 1993-11-05 14:45:11 +0000 | [diff] [blame] | 150 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 151 | # Quarterly document |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 152 | qua.dvi: qua.tex quabib.bib |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 153 | $(LATEX) qua |
| 154 | $(BIBTEX) qua |
| 155 | $(LATEX) qua |
| 156 | $(BIBTEX) qua |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 157 | |
| 158 | qua.ps: qua.dvi |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 159 | $(DVIPS) qua >qua.ps |
Guido van Rossum | b3fa13c | 1991-01-22 11:47:14 +0000 | [diff] [blame] | 160 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 161 | |
| 162 | # The remaining part of the Makefile is concerned with various |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 163 | # conversions, as described above. See also the README file. |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 164 | |
Fred Drake | a39a25e | 1996-09-13 14:44:34 +0000 | [diff] [blame] | 165 | .SUFFIXES: .py .pyc |
| 166 | |
| 167 | .py.pyc: |
| 168 | $(PYTHON) -c "import $*" |
Guido van Rossum | 95cd2ef | 1992-12-08 14:37:55 +0000 | [diff] [blame] | 169 | |
Guido van Rossum | 7a2dba2 | 1993-11-05 14:45:11 +0000 | [diff] [blame] | 170 | .PRECIOUS: lib.texi |
| 171 | |
Fred Drake | a39a25e | 1996-09-13 14:44:34 +0000 | [diff] [blame] | 172 | lib.texi: lib*.tex texipre.dat texipost.dat partparse.pyc fix.el |
| 173 | $(PARTPARSE) -o @lib.texi `./whichlibs` |
| 174 | $(EMACS) -batch -l fix.el -f save-buffer -kill |
| 175 | mv @lib.texi lib.texi |
| 176 | |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 177 | python-lib.info: lib.texi |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 178 | -$(MAKEINFO) --footnote-style end --fill-column 72 \ |
| 179 | --paragraph-indent 0 lib.texi |
Guido van Rossum | 7a2dba2 | 1993-11-05 14:45:11 +0000 | [diff] [blame] | 180 | |
| 181 | lib.info: python-lib.info |
| 182 | |
Fred Drake | a39a25e | 1996-09-13 14:44:34 +0000 | [diff] [blame] | 183 | libwww: lib.texi texi2html.pyc |
Guido van Rossum | eb8d503 | 1996-08-09 21:46:05 +0000 | [diff] [blame] | 184 | if test ! -d $(LIBHTMLDIR); then mkdir $(LIBHTMLDIR); else true; fi |
Fred Drake | 5f2aa71 | 1996-10-09 19:33:17 +0000 | [diff] [blame] | 185 | $(TEXI2HTML) $(TEXI2HTMLFLAGS) lib.texi $(LIBHTMLDIR) |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 186 | |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 187 | # Targets to convert the manuals to HTML using Nikos Drakos' LaTeX to |
| 188 | # HTML converter. For more info on this program, see |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 189 | # <URL:http://cbl.leeds.ac.uk/nikos/tex2html/doc/latex2html/latex2html.html>. |
| 190 | # (I've had some trouble getting this to work with the netpbm version |
| 191 | # of the pbmplus library; ppmtogif dumped core because giftopnm |
| 192 | # outputs bitmap (pbm) files. I've fixed this by changing the source |
| 193 | # of LaTeX2HTML to insert a call to pnmtoppm, which I wrote myself. |
| 194 | # You can probably also use "pbmtopgm | pgmtoppm"... |
| 195 | |
| 196 | # In order to use these targets, you must edit the definition of L2H |
Guido van Rossum | 73827c6 | 1995-03-20 13:00:32 +0000 | [diff] [blame] | 197 | # earlier in the Makefile to point to the latex2html program. Note |
| 198 | # that LaTeX2HTML inserts references to an "icons" directory in each |
| 199 | # page that it generates. You can customize where these icons are to |
| 200 | # be found; I generally make it point to "../icons" and then create a |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 201 | # symbolic link to the icons directory in the LaTeX2HTML source at the |
| 202 | # appropriate place. |
| 203 | |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 204 | l2h: l2htut l2href l2hext |
| 205 | |
Guido van Rossum | f8daa4f | 1996-08-23 15:33:51 +0000 | [diff] [blame] | 206 | l2htut: tut.dvi |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 207 | $(L2H) $(L2HARGS) tut.tex |
| 208 | @rm -rf python-tut |
| 209 | mv tut python-tut |
| 210 | |
Guido van Rossum | f8daa4f | 1996-08-23 15:33:51 +0000 | [diff] [blame] | 211 | l2hext: ext.dvi |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 212 | $(L2H) $(L2HARGS) ext.tex |
| 213 | @rm -rf python-ext |
| 214 | mv ext python-ext |
Guido van Rossum | 970871f | 1993-02-21 20:10:26 +0000 | [diff] [blame] | 215 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 216 | # This target doesn't quite work, since l2h doesn't understand the |
| 217 | # funcdesc and similar environments, and turns them into GIF images. |
| 218 | # Use the "libwww" target above instead. |
Guido van Rossum | f8daa4f | 1996-08-23 15:33:51 +0000 | [diff] [blame] | 219 | l2hlib: lib.dvi |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 220 | $(L2H) $(L2HARGS) lib.tex |
| 221 | @rm -rf python-lib |
| 222 | mv lib python-lib |
| 223 | |
| 224 | |
| 225 | # Housekeeping targets |
| 226 | |
| 227 | # Remove temporary files |
Guido van Rossum | 7f777ed | 1990-08-09 14:25:15 +0000 | [diff] [blame] | 228 | clean: |
Guido van Rossum | 4ac605e | 1992-12-17 15:31:02 +0000 | [diff] [blame] | 229 | rm -f @* *~ *.aux *.idx *.ilg *.ind *.log *.toc *.blg *.bbl *.pyc |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 230 | rm -f *.bak *.orig |
Guido van Rossum | 5b34373 | 1992-07-07 09:06:34 +0000 | [diff] [blame] | 231 | # Sources: .tex, .bib, .sty |
Guido van Rossum | 7a2dba2 | 1993-11-05 14:45:11 +0000 | [diff] [blame] | 232 | # Useful results: .dvi, .ps, .texi, .info |
Guido van Rossum | 5b34373 | 1992-07-07 09:06:34 +0000 | [diff] [blame] | 233 | |
Guido van Rossum | e83e380 | 1995-03-17 16:01:35 +0000 | [diff] [blame] | 234 | # Remove temporaries as well as final products |
Guido van Rossum | 5b34373 | 1992-07-07 09:06:34 +0000 | [diff] [blame] | 235 | clobber: clean |
Guido van Rossum | 7a2dba2 | 1993-11-05 14:45:11 +0000 | [diff] [blame] | 236 | rm -f *.dvi *.ps *.texi *.info *.info-[0-9]* |