Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
cpython/Doc/html/Makefile

113 lines
2.8 KiB
Makefile
Raw Normal View History

Sub-makefile that can be used to drive the HTML conversion from this subdir. Most of the logic is still in the primary Makefile and a new script in Doc/tools/.
1998-05-07 11:50:22 -03:00
# Convenience Makefile for building HTML documentation. You probably need to
# set TEXINPUTS from the command line for this to be useful, unless you
# actually build the .dvi files in the top level directory.
#
# Note that the .dvi files must already be built and TEXINPUTS must include the
# directory where latex's working files (esp. *.aux) are kept.
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
PAPER=letter
Clean things up just a bit.
1998-08-11 16:36:35 -03:00
TOPDIR=..
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
TOOLSDIR=$(TOPDIR)/tools
PAPERDIR=$(TOPDIR)/paper-$(PAPER)
Clean things up just a bit.
1998-08-11 16:36:35 -03:00
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
TEXINPUTS=$(TOPDIR)/paper-$(PAPER):$(TOPDIR)/texinputs:
Clean things up just a bit.
1998-08-11 16:36:35 -03:00
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
# Where are the various programs?
HTMLBASE: New variable. Make it easier to check an "installed" copy of the HTML documents using the webcheck target. When there's not a usable .aux file, use mkdvi.sh --aux instead of building the .dvi completely. This makes the most difference for the library reference.
1999-02-15 15:29:08 -04:00
PYTHON= python
WEBCHECKER=$(PYTHON) $(TOPDIR)/../Tools/webchecker/webchecker.py
MKAUX= PAPER=$(PAPER) TEXINPUTS=$(TEXINPUTS) $(TOOLSDIR)/mkdvi.sh --aux
MKHTML= PAPER=$(PAPER) $(TOOLSDIR)/mkhtml.sh
KPSEWHICH= TEXINPUTS=$(TEXINPUTS) kpsewhich tex
Clean things up just a bit.
1998-08-11 16:36:35 -03:00
HTMLBASE: New variable. Make it easier to check an "installed" copy of the HTML documents using the webcheck target. When there's not a usable .aux file, use mkdvi.sh --aux instead of building the .dvi completely. This makes the most difference for the library reference.
1999-02-15 15:29:08 -04:00
BUILDINDEX=$(TOOLSDIR)/buildindex.py
Make the documents that have indexes dependent on the buildindex.py script.
1999-01-05 11:49:39 -04:00
L2HARGS: Specify the HTML version we're producing, since this is what we generate anyway.
1999-02-12 17:42:23 -04:00
# make it clear to l2h, since our support only generates HTML 4.0
HTMLBASE: New variable. Make it easier to check an "installed" copy of the HTML documents using the webcheck target. When there's not a usable .aux file, use mkdvi.sh --aux instead of building the .dvi completely. This makes the most difference for the library reference.
1999-02-15 15:29:08 -04:00
L2HARGS= -html_version 4.0
Pass in the 'Send comments to ...' on the mkmodindex command line, just like we do for mkhowto.
1999-03-04 17:25:05 -04:00
PYTHONDOCS='<hr>Send comments to <a href="mailto:python-docs@python.org">python-docs@python.org</a>.'
HTMLBASE: New variable. Make it easier to check an "installed" copy of the HTML documents using the webcheck target. When there's not a usable .aux file, use mkdvi.sh --aux instead of building the .dvi completely. This makes the most difference for the library reference.
1999-02-15 15:29:08 -04:00
HTMLBASE= file:`pwd`
L2HARGS: Specify the HTML version we're producing, since this is what we generate anyway.
1999-02-12 17:42:23 -04:00
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
INDEXFILES=api/api.html \
ext/ext.html \
lib/lib.html \
mac/mac.html \
ref/ref.html \
tut/tut.html
Clean things up just a bit.
1998-08-11 16:36:35 -03:00
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
COMMONPERL= $(TOPDIR)/perl/manual.perl \
Add l2hinit.perl to COMMONPERL.
1998-08-13 16:03:19 -03:00
$(TOPDIR)/perl/python.perl \
$(TOPDIR)/perl/l2hinit.perl
Sub-makefile that can be used to drive the HTML conversion from this subdir. Most of the logic is still in the primary Makefile and a new script in Doc/tools/.
1998-05-07 11:50:22 -03:00
Add target for modindex.html; a combined lib+mac module index. Also built with target "all".
1999-02-24 13:34:12 -04:00
all: $(INDEXFILES) modindex.html
Sub-makefile that can be used to drive the HTML conversion from this subdir. Most of the logic is still in the primary Makefile and a new script in Doc/tools/.
1998-05-07 11:50:22 -03:00
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
.PHONY: api ext lib mac ref tut
Sub-makefile that can be used to drive the HTML conversion from this subdir. Most of the logic is still in the primary Makefile and a new script in Doc/tools/.
1998-05-07 11:50:22 -03:00
Remove stuff related to copying the icons directory around -- just isn't needed.
1999-02-15 17:43:55 -04:00
api: api/api.html
ext: ext/ext.html
lib: lib/lib.html
mac: mac/mac.html
ref: ref/ref.html
tut: tut/tut.html
Sub-makefile that can be used to drive the HTML conversion from this subdir. Most of the logic is still in the primary Makefile and a new script in Doc/tools/.
1998-05-07 11:50:22 -03:00
Add a --address parameter to the mkhowto command line to direct documentation comments appropriately. In response to comment from Martijn Faassen <faassen@vet.uu.nl>. Add dependency to about.dat.
1998-11-30 16:28:35 -04:00
$(INDEXFILES): $(COMMONPERL) $(TOPDIR)/html/about.dat
Sub-makefile that can be used to drive the HTML conversion from this subdir. Most of the logic is still in the primary Makefile and a new script in Doc/tools/.
1998-05-07 11:50:22 -03:00
Add target for modindex.html; a combined lib+mac module index. Also built with target "all".
1999-02-24 13:34:12 -04:00
modindex.html: lib/lib.html mac/mac.html $(TOOLSDIR)/mkmodindex
Only use 4 columns in the module index, to accomodate platform annotations.
1999-03-02 11:56:19 -04:00
$(TOOLSDIR)/mkmodindex --columns 4 --output modindex.html \
Pass in the 'Send comments to ...' on the mkmodindex command line, just like we do for mkhowto.
1999-03-04 17:25:05 -04:00
--address $(PYTHONDOCS) \
Add target for modindex.html; a combined lib+mac module index. Also built with target "all".
1999-02-24 13:34:12 -04:00
lib/modindex.html mac/modindex.html
Make the documents that have indexes dependent on the buildindex.py script.
1999-01-05 11:49:39 -04:00
api/api.html: $(PAPERDIR)/api.aux $(BUILDINDEX)
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
$(MKHTML) api $(L2HARGS)
Add support for the Macintosh Library Modules document.
1998-05-15 14:02:10 -03:00
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
ext/ext.html: $(PAPERDIR)/ext.aux
$(MKHTML) ext $(L2HARGS)
Sub-makefile that can be used to drive the HTML conversion from this subdir. Most of the logic is still in the primary Makefile and a new script in Doc/tools/.
1998-05-07 11:50:22 -03:00
Make the documents that have indexes dependent on the buildindex.py script.
1999-01-05 11:49:39 -04:00
lib/lib.html: $(PAPERDIR)/lib.aux $(BUILDINDEX)
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
$(TOOLSDIR)/fix_libaux.sed <`$(KPSEWHICH) lib.aux` >lib1.aux
mv lib1.aux `$(KPSEWHICH) lib.aux`
$(MKHTML) lib $(L2HARGS)
Sub-makefile that can be used to drive the HTML conversion from this subdir. Most of the logic is still in the primary Makefile and a new script in Doc/tools/.
1998-05-07 11:50:22 -03:00
Make the documents that have indexes dependent on the buildindex.py script.
1999-01-05 11:49:39 -04:00
mac/mac.html: $(MACFILES) $(BUILDINDEX)
Pass in the 'Send comments to ...' on the mkmodindex command line, just like we do for mkhowto.
1999-03-04 17:25:05 -04:00
$(TOOLSDIR)/mkhowto --address $(PYTHONDOCS) --html \
$(TOPDIR)/mac/mac.tex
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
Make the documents that have indexes dependent on the buildindex.py script.
1999-01-05 11:49:39 -04:00
ref/ref.html: $(PAPERDIR)/ref.aux $(BUILDINDEX)
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
$(MKHTML) ref $(L2HARGS)
tut/tut.html: $(PAPERDIR)/tut.aux
$(MKHTML) tut $(L2HARGS)
Make the dependencies really work for the HTML version.
1998-10-07 19:03:45 -03:00
include ../Makefile.deps
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
$(PAPERDIR)/api.aux: $(APIFILES)
HTMLBASE: New variable. Make it easier to check an "installed" copy of the HTML documents using the webcheck target. When there's not a usable .aux file, use mkdvi.sh --aux instead of building the .dvi completely. This makes the most difference for the library reference.
1999-02-15 15:29:08 -04:00
(cd $(PAPERDIR); $(MKAUX) api)
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
$(PAPERDIR)/ext.aux: $(EXTFILES)
HTMLBASE: New variable. Make it easier to check an "installed" copy of the HTML documents using the webcheck target. When there's not a usable .aux file, use mkdvi.sh --aux instead of building the .dvi completely. This makes the most difference for the library reference.
1999-02-15 15:29:08 -04:00
(cd $(PAPERDIR); $(MKAUX) ext)
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
$(PAPERDIR)/lib.aux: $(LIBFILES)
HTMLBASE: New variable. Make it easier to check an "installed" copy of the HTML documents using the webcheck target. When there's not a usable .aux file, use mkdvi.sh --aux instead of building the .dvi completely. This makes the most difference for the library reference.
1999-02-15 15:29:08 -04:00
(cd $(PAPERDIR); $(MKAUX) lib)
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
$(PAPERDIR)/ref.aux: $(REFFILES)
HTMLBASE: New variable. Make it easier to check an "installed" copy of the HTML documents using the webcheck target. When there's not a usable .aux file, use mkdvi.sh --aux instead of building the .dvi completely. This makes the most difference for the library reference.
1999-02-15 15:29:08 -04:00
(cd $(PAPERDIR); $(MKAUX) ref)
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
$(PAPERDIR)/tut.aux: $(TUTFILES)
HTMLBASE: New variable. Make it easier to check an "installed" copy of the HTML documents using the webcheck target. When there's not a usable .aux file, use mkdvi.sh --aux instead of building the .dvi completely. This makes the most difference for the library reference.
1999-02-15 15:29:08 -04:00
(cd $(PAPERDIR); $(MKAUX) tut)
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
HTMLBASE: New variable. Make it easier to check an "installed" copy of the HTML documents using the webcheck target. When there's not a usable .aux file, use mkdvi.sh --aux instead of building the .dvi completely. This makes the most difference for the library reference.
1999-02-15 15:29:08 -04:00
webcheck: all
$(WEBCHECKER) $(HTMLBASE)/api/
$(WEBCHECKER) $(HTMLBASE)/ext/
$(WEBCHECKER) -m290000 $(HTMLBASE)/lib/
$(WEBCHECKER) $(HTMLBASE)/mac/
$(WEBCHECKER) $(HTMLBASE)/ref/
$(WEBCHECKER) $(HTMLBASE)/tut/
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
clean:
Remove stuff related to copying the icons directory around -- just isn't needed.
1999-02-15 17:43:55 -04:00
rm -rf @webchecker.pickle
Re-written to actually perform the conversion instead of using a sub-make with the parent Makefile. Will also force the auxillary files to be created if they need to be.
1998-08-12 14:06:03 -03:00
clobber: clean
rm -rf api/ ext/ lib/ mac/ ref/ tut/