X-Git-Url: http://gitweb.michael.orlitzky.com/?p=mjotex.git;a=blobdiff_plain;f=GNUmakefile;h=3f941fbeab7dd637502a99481e73c497dad57aeb;hp=8f9fc6be76dda4c376ae9f47754fd1037d6caf05;hb=f9205a3b883c08499edfdd3f9d1a6170a6fc6755;hpb=7321e6c665f3b9797bb7a76618e6419a33357e6c

diff --git a/GNUmakefile b/GNUmakefile
index 8f9fc6b..3f941fb 100644
--- 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
@@ -13,15 +18,32 @@ PN = examples
 #
 # Leave commented if you don't use a bibliography database.
 #
-#BIBS = references.bib
+BIBS = local-references.bib
 
 # 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-complex.tex
-MJOTEX += mjo-cone.tex mjo-convex.tex mjo-font.tex mjo-linear_algebra.tex
-MJOTEX += mjo-listing.tex mjo-misc.tex mjo-proof_by_cases.tex mjo-theorem.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-proof_by_cases.tex mjo-set.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))
+
+# A space-separated list of indices (just their names). Usually you'll
+# have just one, and it will be named the same thing as your document,
+# because that's what the makeidx package does.
+#
+# Leave commented if you don't use an index.
+#
+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 +56,14 @@ 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))
+endif
 
 # The first target is the default, so put the PDF document first.
 #
@@ -70,7 +99,7 @@ endif
 # version of pdflatex makes it into TeX Live 2016, we can replace
 # those two sed scripts with something smarter.
 #
-$(PN).pdf: $(SRCS) $(PN).bbl
+$(PN).pdf: $(SRCS) $(PN).bbl $(INDEX_DSTS)
 	$(LATEX) $(PN).tex
 
 	sed --in-place \
@@ -96,6 +125,25 @@ $(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. We depend on SRCS here because we *do* want to rebuild the
+# index if the source document changes, but we use an order-only
+# dependency (see the bbl rule below) on the idx files to prevent us
+# from going into a rebuild loop when the idx files are regenerated.
+%.ind: $(SRCS) | %.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 +174,12 @@ $(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,
+# and then we replace any blank lines by "<BLANKLINE>".
+sage_listings/%.py: sage_listings/%.listing
+	echo '"""' > $@ && cat $< >> $@ && echo '"""' >> $@ && sed -i 's/^[[:space:]]*$$/<BLANKLINE>/' $@
+
 # Ensure that there are no overfull or underfull boxes in the output
 # document by parsing the log for said warnings.
 .PHONY: check-boxes
@@ -133,7 +187,7 @@ check-boxes: $(PN).log
 	@! grep -i 'overfull\|underfull' $<
 
 # Run chktex to find silly mistakes. There is some exit code weirdness
-# (Savannah bug 45979), so we just look for empty output.
+# (Savannah bug 53129), so we just look for empty output.
 .PHONY: check-chktex
 CHKTEX = chktex --localrc .chktexrc --quiet --inputfiles=0
 check-chktex:
@@ -145,19 +199,30 @@ 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
+	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
 # will execute these commands using /bin/sh (which should be POSIX).
-JUNK_EXTENSIONS  = aux bbl bcf bib blg listing lof log nav out pdf
+JUNK_EXTENSIONS  = aux bbl bcf blg glo ilg ist listing lof log nav out pdf
 JUNK_EXTENSIONS += snm spl toc xml
 .PHONY: clean
 clean:
 	for ext in $(JUNK_EXTENSIONS); do rm -f *.$$ext; done;
 	rm -rf dist/
+	rm -f $(SAGE_LISTING_DSTS) $(INDEX_SRCS) $(INDEX_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