Add index support.

[mjotex.git] / GNUmakefile

diff --git a/GNUmakefile b/GNUmakefile
index 4b738f096e9b6155e840c40f73c418fb9d09a6ff..a2e2ec2159831a93b9b1eb787df356162206e2f9 100644 (file)
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -6,6 +6,11 @@
 LATEX = pdflatex -file-line-error -halt-on-error
 
 # The name of this document.
+#
+# For example, to use the name of our parent directory:
+#
+# PN = $(notdir $(realpath .))
+#
 PN = examples
 
 # A space-separated list of bib files. These must all belong to paths
@@ -17,11 +22,22 @@ PN = examples
 
 # A space-separated list of the mjotex files that you use. The path to
 # mjotex must be contain in your $TEXINPUTS environment variable.
-MJOTEX  = mjo-algorithm.tex mjo-arrow.tex mjo-common.tex mjo-cone.tex
-MJOTEX += mjo-convex.tex mjo-font.tex mjo-linear_algebra.tex mjo-listing.tex
+#
+# MJOTEX  = mjotex.sty
+#
+MJOTEX  = mjo-algebra.tex mjo-algorithm.tex mjo-arrow.tex mjo-calculus.tex
+MJOTEX += mjo-common.tex mjo-complex.tex mjo-cone.tex mjo-convex.tex
+MJOTEX += mjo-eja.tex mjo-font.tex mjo-linear_algebra.tex mjo-listing.tex
 MJOTEX += mjo-misc.tex mjo-proof_by_cases.tex mjo-theorem.tex
 MJOTEX += mjo-theorem-star.tex mjo-topology.tex mjo.bst
 
+# Compile a list of raw source code listings (*.listing) and their
+# associated output files (*.py) that will be tested by check-sage.
+SAGE_LISTING_SRCS = $(wildcard sage_listings/*.listing)
+SAGE_LISTING_DSTS = $(patsubst %.listing,%.py,$(SAGE_LISTING_SRCS))
+
+INDICES = $(PN)
+
 # Use kpsewhich (from the kpathsea suite) to find the absolute paths
 # of the bibtex/mjotex files listed in in $(BIBS)/$(MJOTEX). The SRCS
 # variable should contain all (Bib)TeX source files for the document.
@@ -34,7 +50,15 @@ ifdef MJOTEX
 MJOTEXPATHS = $(shell kpsewhich $(MJOTEX))
 SRCS += $(MJOTEXPATHS)
 endif
+ifdef SAGE_LISTING_DSTS
+SRCS += $(SAGE_LISTING_DSTS)
+endif
 
+ifdef INDICES
+INDEX_SRCS = $(addsuffix .idx,$(INDICES))
+INDEX_DSTS = $(addsuffix .ind,$(INDICES))
+SRCS += $(INDEX_DSTS)
+endif
 
 # The first target is the default, so put the PDF document first.
 #
@@ -96,6 +120,21 @@ $(PN).aux: $(SRCS)
        $(LATEX) $(PN).tex
 
 
+ifdef INDICES
+# We need to be able to build the index source files without involving
+# the main $(PN).pdf rule, in order to avoid a chicken-and-egg problem.
+# This is similar to the $(PN).aux rule above, except that an index is
+# optional and there might be more than one of them.
+$(INDEX_SRCS): $(PN).tex
+       $(LATEX) $(PN).tex
+endif
+
+ifdef INDICES
+# Create real indices from source files by running "makeindex" on them.
+%.ind: %.idx
+       makeindex $<
+endif
+
 # The pipe below indicates an "order-only dependency" on the aux file.
 # Without it, every compilation of $(PN).tex would produce a new
 # $(PN).aux, and thus $(PN).bbl would be rebuilt. This in turn causes
@@ -126,6 +165,11 @@ $(PN).log: $(SRCS)
        $(MAKE) clean
        $(MAKE)
 
+# How do we convert a raw listing into something testable by sage? We
+# append/prepend triple quotes to make the whole thing into a doctest.
+sage_listings/%.py: sage_listings/%.listing
+       echo '"""' > $@ && cat $< >> $@ && echo '"""' >> $@
+
 # Ensure that there are no overfull or underfull boxes in the output
 # document by parsing the log for said warnings.
 .PHONY: check-boxes
@@ -135,8 +179,9 @@ check-boxes: $(PN).log
 # Run chktex to find silly mistakes. There is some exit code weirdness
 # (Savannah bug 45979), so we just look for empty output.
 .PHONY: check-chktex
+CHKTEX = chktex --localrc .chktexrc --quiet --inputfiles=0
 check-chktex:
-       @[ -z "$(shell chktex --quiet mjotex.sty)" ]
+       @[ -z "$(shell $(CHKTEX) mjotex.sty)" ]
 
 # Ensure that there are no undefined references in the document by
 # parsing the log file for said warnings.
@@ -144,9 +189,21 @@ check-chktex:
 check-undefined: $(PN).log
        @! grep -i 'undefined' $<
 
+# Use sage to doctest any \sagelisting{}s in SAGE_LISTING_DSTS.
+# The actuall command is ifdef'd so that we can comment out
+# the definition of SAGE_LISTING_DSTS without breaking the
+# default definition of the "check" target.
+.PHONY: check-sage
+check-sage: $(SAGE_LISTING_DSTS)
+ifdef SAGE_LISTING_DSTS
+       PYTHONPATH="$(HOME)/src/sage.d" \
+          sage -t --timeout=0 --memlimit=0 \
+          $^
+endif
+
 # Run a suite of checks.
 .PHONY: check
-check: check-boxes check-chktex check-undefined
+check: check-boxes check-chktex check-undefined check-sage
 
 # Clean up leftover junk. This only looks overcomplicated because
 # the *.{foo,bar} syntax supported by Bash is not POSIX, and Make
@@ -157,6 +214,7 @@ JUNK_EXTENSIONS += snm spl toc xml
 clean:
        for ext in $(JUNK_EXTENSIONS); do rm -f *.$$ext; done;
        rm -rf dist/
+       rm -f $(SAGE_LISTING_DSTS)
 
 # If this document will be published, the publisher isn't going to
 # have your BibTeX database or your mjotex files. So, you need to