summaryrefslogtreecommitdiffstats
path: root/Doc/Makefile
blob: 2b8596b62a9c22f468f05f4b9db7b5cc59b266ca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
# Makefile for Python documentation
# ---------------------------------
#
# See also the README file.
#
# This is a bit of a mess.  The main documents are:
#   tut -- Tutorial (file tut.tex)
#   lib -- Library Reference (file lib.tex, inputs lib*.tex)
#   ext -- Extending and Embedding (file ext.tex)
#   api -- Python-C API Reference
#
# The Reference Manual is now maintained as a FrameMaker document.
# See the subdirectory ref; PostScript is included as ref/ref.ps.
# (In the future, the Tutorial will also be converted to FrameMaker;
# the other documents will be maintained in a text format such
# as LaTeX or perhaps TIM.)
#
# The main target "make all" creates DVI and PostScript for these
# four.  You can also do "make lib" (etc.) to process individual
# documents.
#
# There's one local style file: python.sty.  This defines a number
# of macros that are similar in name and intent as macros in Texinfo
# (e.g. \code{...} and \emph{...}), as well as a number of
# environments for formatting function and data definitions, also in
# the style of Texinfo.
#
# Everything is processed by LaTeX.  The following tools are used:
#   latex
#   makeindex
#   dvips
#
# There's a problem with generating the index which has been solved by
# a sed command applied to the index file.  The shell script fix_hack
# does this (the Makefile takes care of calling it).
#
# To preview the dvi files produced by LaTeX it would be useful to
# have xdvi as well.
#
# Additional targets attempt to convert selected LaTeX sources to
# various other formats.  These are generally site specific because
# the tools used are all but universal.  These targets are:
#   l2h -- convert tut, lib, ext, api from LaTeX to HTML
# See the README file for more info on these targets.

# Customizations -- you *may* have to edit these

# Where are the various programs?
LATEX=		latex
PDFLATEX=	pdflatex
BIBTEX=		bibtex
DVIPS=		dvips -f -N0
DISTILL=	distill
MAKEINDEX=	makeindex
L2H=		latex2html
L2HARGS=	-address $$LOGNAME@`domainname`

# Install destination -- not used now but might be useful some time...
DESTDIR=	/usr/local
LIBDESTDIR=	$DESTDIR/lib
LIBDEST=	$LIBDESTDIR/python
DOCDESTDIR=	$LIBDEST/doc

# This is only used for .info generation:
EMACS=		emacs
PYTHON=		python
MAKEINFO=	makeinfo
# When debugging partparse.py, make this the pyc file:
PARTPARSEOBJ=	partparse.pyc
PARTPARSE=	$(PYTHON) $(PARTPARSEOBJ)

# Ideally, you shouldn't need to edit beyond this point

VERSION=1.5

DVIFILES=	api.dvi ext.dvi lib.dvi tut.dvi
INFOFILES=	python-lib.info
PDFFILES=	api.pdf ext.pdf lib.pdf tut.pdf
PSFILES=	api.ps ext.ps lib.ps tut.ps

# Main target
all:	all-ps

all-dvi: $(DVIFILES)
all-pdf: $(PDFFILES)
all-ps:	 $(PSFILES)

# This target gets both the PDF and PS files updated; the all-pdf target
# above doesn't ensure that both are done if the "alternate" rule (using
# pdflatex) for PDF generation is used.
#
all-formats:  $(PSFILES) $(PDFFILES)

# Individual document fake targets
tut:	tut.ps
lib:	lib.ps
ext:	ext.ps
api:	api.ps

# All formats for a single document
api-all:  api.dvi api.pdf api.ps l2hapi
ext-all:  ext.dvi ext.pdf ext.ps l2hext
lib-all:  lib.dvi lib.pdf lib.ps l2hlib
tut-all:  tut.dvi tut.pdf tut.ps l2htut


# Rules to build PostScript and PDF formats
.SUFFIXES: .dvi .ps .pdf .tex

.dvi.ps:
	$(DVIPS) $< >$@

#.ps.pdf:
#	$(DISTILL) $<

# An alternate formulation of PDF creation; requires latex format with
# pdftex.  To use this instead of the Acrobat distiller solution, comment
# out the above .ps.pdf rule and uncomment this rule.  This was tested
# using a pre-release of the teTeX distribution.  See
# http://www.tug.org/tetex/ for more information on getting & using teTeX.
# This rule avoids creation of the intermediate PostScript files and uses
# only free software.
#
.dvi.pdf:
	$(PDFLATEX) $*

# Dependencies
COMMONTEX=python.sty manual.cls copyright.tex boilerplate.tex

$(DVIFILES): fix_hack $(COMMONTEX)

# LaTeX source files for the Python Library Reference
LIBFILES = lib.tex \
    libintro.tex libobjs.tex libtypes.tex libexcs.tex libfuncs.tex \
    libpython.tex libsys.tex libtypes2.tex libtraceback.tex libpickle.tex \
    libshelve.tex libcopy.tex libmarshal.tex libimp.tex libparser.tex \
    libbltin.tex libmain.tex libstrings.tex libstring.tex libregex.tex \
    libregsub.tex libstruct.tex libmisc.tex libmath.tex librand.tex \
    libwhrandom.tex libarray.tex liballos.tex libos.tex libtime.tex \
    libgetopt.tex libtempfile.tex liberrno.tex libsomeos.tex libsignal.tex \
    libsocket.tex libselect.tex libthread.tex libunix.tex libposix.tex \
    libppath.tex libpwd.tex libgrp.tex libcrypt.tex libdbm.tex libgdbm.tex \
    libtermios.tex libfcntl.tex libposixfile.tex libsyslog.tex libpdb.tex \
    libprofile.tex libwww.tex libcgi.tex liburllib.tex libhttplib.tex \
    libftplib.tex libgopherlib.tex libnntplib.tex liburlparse.tex \
    libhtmllib.tex libsgmllib.tex librfc822.tex libmimetools.tex \
    libbinascii.tex libmm.tex libaudioop.tex libimageop.tex libaifc.tex \
    libjpeg.tex librgbimg.tex libcrypto.tex libmd5.tex libmpz.tex \
    librotor.tex libmac.tex libctb.tex libmacconsole.tex libmacdnr.tex \
    libmacfs.tex libmacos.tex libmacostools.tex libmactcp.tex \
    libmacspeech.tex libmacui.tex libstdwin.tex libsgi.tex libal.tex \
    libcd.tex libfl.tex libfm.tex libgl.tex libimgfile.tex libsun.tex \
    libxdrlib.tex libimghdr.tex \
    librestricted.tex librexec.tex libbastion.tex \
    libformatter.tex liboperator.tex libsoundex.tex libresource.tex \
    libstat.tex libstrio.tex libundoc.tex libmailcap.tex libglob.tex \
    libuser.tex libanydbm.tex librandom.tex libsite.tex libwhichdb.tex \
    libbase64.tex libfnmatch.tex libquopri.tex libzlib.tex libsocksvr.tex \
    libmailbox.tex libcommands.tex libcmath.tex libni.tex libgzip.tex \
    libpprint.tex libcode.tex libmimify.tex libre.tex libmacic.tex \
    libuserdict.tex libdis.tex libxmllib.tex libqueue.tex \
    liblocale.tex libbasehttp.tex libcopyreg.tex libsymbol.tex libtoken.tex \
    libframework.tex libminiae.tex libbinhex.tex libuu.tex libsunaudio.tex

# Library document
lib.dvi: modindex.py indfix.py $(LIBFILES)
	./newind.py >$*.ind
	./newind.py modindex >mod$*.ind
	$(LATEX) $*
	./modindex.py mod$*.idx
	./fix_hack $*.idx
	$(MAKEINDEX) $*.idx
	./indfix.py $*.ind
	$(LATEX) $*

# Tutorial document
tut.dvi: tut.tex 
	$(LATEX) $*
	$(LATEX) $*

# Extending & Embedding, Python/C API documents.
# Done this way to avoid repeated command sets.
.tex.dvi:
	./newind.py >$*.ind
	$(LATEX) $*
	./fix_hack $*.idx
	$(MAKEINDEX) $*.idx
	$(LATEX) $*


# The remaining part of the Makefile is concerned with various
# conversions, as described above.  See also the README file.

.SUFFIXES: .py .pyc .pyo

.py.pyo:
	$(PYTHON) -O -c "import $*"

.py.pyc:
	$(PYTHON) -c "import $*"

.PRECIOUS:	python-lib.texi

# The sed script in this target fixes a really nasty little condition in
# libcgi.tex where \e has to be used in a group to get the right behavior,
# and makeinfo can't handle a group without a leading @command.  But at
# least the info file gets generated.

lib1.texi: $(LIBFILES) texipre.dat texipost.dat $(PARTPARSEOBJ)
	$(PARTPARSE) -o $@ `./whichlibs`
	sed 's/"{\\}n{\\}n/"\\n\\n/' $@ >temp.texi
	mv temp.texi $@

python-lib.texi: lib1.texi fix.el
	cp lib1.texi temp.texi
	$(EMACS) -batch -l fix.el -f save-buffer -kill
	mv temp.texi $@

python-lib.info: python-lib.texi
	$(MAKEINFO) --footnote-style end --fill-column 72 \
		     --paragraph-indent 0 $<

# this is needed to prevent a second set of info files from being generated,
# at least when using GNU make
.PHONY: lib.info lib.texi

lib.info: python-lib.info

lib.texi: python-lib.texi

# Targets to convert the manuals to HTML using Nikos Drakos' LaTeX to
# HTML converter.  For more info on this program, see
# <URL:http://cbl.leeds.ac.uk/nikos/tex2html/doc/latex2html/latex2html.html>.

# Note that LaTeX2HTML inserts references to an icons directory in
# each page that it generates.  I have placed a copy of this directory
# in the distribution to simplify the process of creating a
# self-contained HTML distribution; for this purpose I have also added
# a (trivial) index.html.  Change the definition of $ICONSERVER in
# .latex2html-init to use a different location for the icons directory.

l2h: l2hapi l2hext l2hlib l2htut

l2htut: tut.dvi manual.perl python.perl
	$(L2H) $(L2HARGS) tut.tex
	(cd tut; ../node2label.pl *.html)
	ln -s tut.html tut/index.html || true

l2hext: ext.dvi manual.perl python.perl
	$(L2H) $(L2HARGS) ext.tex
	(cd ext; ../node2label.pl *.html)
	ln -s ext.html ext/index.html || true

l2hlib: lib.dvi manual.perl python.perl
	./fix_libaux.sed <lib.aux >lib1.aux
	mv lib1.aux lib.aux
	if [ -d lib ] ; then rm -f lib/*.html ; fi
	$(L2H) $(L2HARGS) lib.tex
	(cd lib; ../node2label.pl *.html)
	ln -s lib.html lib/index.html || true

l2hapi: api.dvi manual.perl python.perl
	$(L2H) $(L2HARGS) api.tex
	(cd api; ../node2label.pl *.html)
	ln -s api.html api/index.html || true

info-$(VERSION).tar.gz: $(INFOFILES)
	tar cf - python-???.info* | gzip -9 >$@

# This snags a PDF version if available, but doesn't fail if not.
pdf-$(VERSION).tar.gz: $(PDFFILES)
	if [ -f ref/ref.pdf ] ; then cp ref/ref.pdf . ; else true ; fi
	tar cf - ???.pdf | gzip -9 >$@
	if [ -f ref.pdf ] ; then rm ref.pdf ; else true ; fi

postscript-$(VERSION).tar.gz: $(PSFILES) ref/ref.ps
	cp ref/ref.ps .
	tar cf - ???.ps | gzip -9 >$@
	rm ref.ps

tarhtml:
	@echo "Did you remember to run makeMIFs.py in the ref subdirectory...?"
	tar cf - index.html ???/???.css ???/*.html */*.gif \
		| gzip -9 >html-$(VERSION).tar.gz

# convenience targets:

tarinfo:  info-$(VERSION).tar.gz

tarps:	postscript-$(VERSION).tar.gz

tarpdf:	pdf-$(VERSION).tar.gz

tarballs:  tarpdf tarps tarhtml


# Housekeeping targets

# Remove temporary files; all except the following:
# - sources: .tex, .bib, .sty, *.cls
# - useful results: .dvi, .pdf, .ps, .texi, .info
clean:	l2hclean
	rm -f @* *~ *.aux *.idx *.ilg *.ind *.log *.toc *.blg *.bbl *.py[co]
	rm -f *.bak *.orig lib1.texi *.out
	rm -f html-$(VERSION).tar.gz postscript-$(VERSION).tar.gz
	rm -f pdf-$(VERSION).tar.gz

l2hclean:
	rm -rf api ext lib tut

# Remove temporaries as well as final products
clobber: clean
	 rm -f *.dvi *.pdf *.ps *.texi *.info *.info-[0-9]*

realclean:  clobber
distclean:  clobber