blob: 8bbb6912edf7300beefe98f13985cb082c66ced7 [file] [log] [blame]
Fred Drake60515f41998-05-07 14:50:22 +00001# Convenience Makefile for building HTML documentation. You probably need to
2# set TEXINPUTS from the command line for this to be useful, unless you
3# actually build the .dvi files in the top level directory.
4#
5# Note that the .dvi files must already be built and TEXINPUTS must include the
6# directory where latex's working files (esp. *.aux) are kept.
7
Fred Drake07b12f21998-08-12 17:06:03 +00008PAPER=letter
Fred Drakef832f4c1998-08-11 19:36:35 +00009TOPDIR=..
Fred Drake07b12f21998-08-12 17:06:03 +000010TOOLSDIR=$(TOPDIR)/tools
11PAPERDIR=$(TOPDIR)/paper-$(PAPER)
Fred Drakef832f4c1998-08-11 19:36:35 +000012
Fred Drake07b12f21998-08-12 17:06:03 +000013TEXINPUTS=$(TOPDIR)/paper-$(PAPER):$(TOPDIR)/texinputs:
14
15# Where are the various programs?
Fred Drake4d33e4e1999-02-15 19:29:08 +000016PYTHON= python
17WEBCHECKER=$(PYTHON) $(TOPDIR)/../Tools/webchecker/webchecker.py
18MKAUX= PAPER=$(PAPER) TEXINPUTS=$(TEXINPUTS) $(TOOLSDIR)/mkdvi.sh --aux
19MKHTML= PAPER=$(PAPER) $(TOOLSDIR)/mkhtml.sh
20KPSEWHICH= TEXINPUTS=$(TEXINPUTS) kpsewhich tex
Fred Drake07b12f21998-08-12 17:06:03 +000021
Fred Drake4d33e4e1999-02-15 19:29:08 +000022BUILDINDEX=$(TOOLSDIR)/buildindex.py
Fred Drake5d56d361999-01-05 15:49:39 +000023
Fred Drake5761b761999-02-12 21:42:23 +000024# make it clear to l2h, since our support only generates HTML 4.0
Fred Drake4d33e4e1999-02-15 19:29:08 +000025L2HARGS= -html_version 4.0
26
Fred Drakeb41f97d1999-03-04 21:25:05 +000027PYTHONDOCS='<hr>Send comments to <a href="mailto:python-docs@python.org">python-docs@python.org</a>.'
Fred Drake4d33e4e1999-02-15 19:29:08 +000028HTMLBASE= file:`pwd`
Fred Drake5761b761999-02-12 21:42:23 +000029
Fred Drake07b12f21998-08-12 17:06:03 +000030INDEXFILES=api/api.html \
Fred Drake1468d771999-03-18 19:07:04 +000031 doc/doc.html \
Fred Drake07b12f21998-08-12 17:06:03 +000032 ext/ext.html \
33 lib/lib.html \
34 mac/mac.html \
35 ref/ref.html \
36 tut/tut.html
37
38COMMONPERL= $(TOPDIR)/perl/manual.perl \
Fred Drake54c52051998-08-13 19:03:19 +000039 $(TOPDIR)/perl/python.perl \
40 $(TOPDIR)/perl/l2hinit.perl
Fred Drakef832f4c1998-08-11 19:36:35 +000041
42
Fred Drake684f78f1999-02-24 17:34:12 +000043all: $(INDEXFILES) modindex.html
Fred Drake07b12f21998-08-12 17:06:03 +000044
45.PHONY: api ext lib mac ref tut
46
Fred Drake6f9dd5d1999-02-15 21:43:55 +000047api: api/api.html
Fred Drake766e0cb1999-04-05 19:28:29 +000048doc: doc/doc.html
Fred Drake6f9dd5d1999-02-15 21:43:55 +000049ext: ext/ext.html
50lib: lib/lib.html
51mac: mac/mac.html
52ref: ref/ref.html
53tut: tut/tut.html
Fred Drake07b12f21998-08-12 17:06:03 +000054
Fred Drakea8ba3641998-11-30 20:28:35 +000055$(INDEXFILES): $(COMMONPERL) $(TOPDIR)/html/about.dat
Fred Drake07b12f21998-08-12 17:06:03 +000056
Fred Drake684f78f1999-02-24 17:34:12 +000057modindex.html: lib/lib.html mac/mac.html $(TOOLSDIR)/mkmodindex
Fred Drake368b16a1999-03-02 15:56:19 +000058 $(TOOLSDIR)/mkmodindex --columns 4 --output modindex.html \
Fred Drakeb41f97d1999-03-04 21:25:05 +000059 --address $(PYTHONDOCS) \
Fred Drake684f78f1999-02-24 17:34:12 +000060 lib/modindex.html mac/modindex.html
61
Fred Drake5d56d361999-01-05 15:49:39 +000062api/api.html: $(PAPERDIR)/api.aux $(BUILDINDEX)
Fred Drake07b12f21998-08-12 17:06:03 +000063 $(MKHTML) api $(L2HARGS)
64
Fred Drake1468d771999-03-18 19:07:04 +000065doc/doc.html: $(DOCFILES) $(BUILDINDEX) $(TOPDIR)/perl/ltxmarkup.perl
66 $(TOOLSDIR)/mkhowto --address $(PYTHONDOCS) --html \
67 $(TOPDIR)/doc/doc.tex
68
Fred Drake07b12f21998-08-12 17:06:03 +000069ext/ext.html: $(PAPERDIR)/ext.aux
70 $(MKHTML) ext $(L2HARGS)
71
Fred Drake5d56d361999-01-05 15:49:39 +000072lib/lib.html: $(PAPERDIR)/lib.aux $(BUILDINDEX)
Fred Drake07b12f21998-08-12 17:06:03 +000073 $(TOOLSDIR)/fix_libaux.sed <`$(KPSEWHICH) lib.aux` >lib1.aux
74 mv lib1.aux `$(KPSEWHICH) lib.aux`
75 $(MKHTML) lib $(L2HARGS)
76
Fred Drake5d56d361999-01-05 15:49:39 +000077mac/mac.html: $(MACFILES) $(BUILDINDEX)
Fred Drakeb41f97d1999-03-04 21:25:05 +000078 $(TOOLSDIR)/mkhowto --address $(PYTHONDOCS) --html \
79 $(TOPDIR)/mac/mac.tex
Fred Drake07b12f21998-08-12 17:06:03 +000080
Fred Drake5d56d361999-01-05 15:49:39 +000081ref/ref.html: $(PAPERDIR)/ref.aux $(BUILDINDEX)
Fred Drake07b12f21998-08-12 17:06:03 +000082 $(MKHTML) ref $(L2HARGS)
83
84tut/tut.html: $(PAPERDIR)/tut.aux
85 $(MKHTML) tut $(L2HARGS)
Fred Drakef832f4c1998-08-11 19:36:35 +000086
Fred Drake60515f41998-05-07 14:50:22 +000087
Fred Drake2e23c311998-10-07 22:03:45 +000088include ../Makefile.deps
89
Fred Drake07b12f21998-08-12 17:06:03 +000090$(PAPERDIR)/api.aux: $(APIFILES)
Fred Drake4d33e4e1999-02-15 19:29:08 +000091 (cd $(PAPERDIR); $(MKAUX) api)
Fred Drake60515f41998-05-07 14:50:22 +000092
Fred Drake07b12f21998-08-12 17:06:03 +000093$(PAPERDIR)/ext.aux: $(EXTFILES)
Fred Drake4d33e4e1999-02-15 19:29:08 +000094 (cd $(PAPERDIR); $(MKAUX) ext)
Fred Drake60515f41998-05-07 14:50:22 +000095
Fred Drake07b12f21998-08-12 17:06:03 +000096$(PAPERDIR)/lib.aux: $(LIBFILES)
Fred Drake4d33e4e1999-02-15 19:29:08 +000097 (cd $(PAPERDIR); $(MKAUX) lib)
Fred Drake60515f41998-05-07 14:50:22 +000098
Fred Drake07b12f21998-08-12 17:06:03 +000099$(PAPERDIR)/ref.aux: $(REFFILES)
Fred Drake4d33e4e1999-02-15 19:29:08 +0000100 (cd $(PAPERDIR); $(MKAUX) ref)
Fred Drake60515f41998-05-07 14:50:22 +0000101
Fred Drake07b12f21998-08-12 17:06:03 +0000102$(PAPERDIR)/tut.aux: $(TUTFILES)
Fred Drake4d33e4e1999-02-15 19:29:08 +0000103 (cd $(PAPERDIR); $(MKAUX) tut)
Fred Drake60515f41998-05-07 14:50:22 +0000104
Fred Drake07b12f21998-08-12 17:06:03 +0000105
Fred Drake4d33e4e1999-02-15 19:29:08 +0000106webcheck: all
107 $(WEBCHECKER) $(HTMLBASE)/api/
Fred Drake1468d771999-03-18 19:07:04 +0000108 $(WEBCHECKER) $(HTMLBASE)/doc/
Fred Drake4d33e4e1999-02-15 19:29:08 +0000109 $(WEBCHECKER) $(HTMLBASE)/ext/
110 $(WEBCHECKER) -m290000 $(HTMLBASE)/lib/
111 $(WEBCHECKER) $(HTMLBASE)/mac/
112 $(WEBCHECKER) $(HTMLBASE)/ref/
113 $(WEBCHECKER) $(HTMLBASE)/tut/
Fred Drake07b12f21998-08-12 17:06:03 +0000114
115clean:
Fred Drake6f9dd5d1999-02-15 21:43:55 +0000116 rm -rf @webchecker.pickle
Fred Drake07b12f21998-08-12 17:06:03 +0000117
118clobber: clean
Fred Drake1468d771999-03-18 19:07:04 +0000119 rm -rf api/ doc/ ext/ lib/ mac/ ref/ tut/