updated Makefile to avoid regenerating figures unless needed

murrayrm · murrayrm · commit cdc5fe806c33 · 2025-02-02T20:57:48.000-08:00
diff --git a/doc/.gitignore b/doc/.gitignore
@@ -1 +1,2 @@
 *.fig.bak
+.docfigs
diff --git a/doc/Makefile b/doc/Makefile
@@ -1,5 +1,17 @@
-# Minimal makefile for Sphinx documentation
-#
+# Makefile for python-control Sphinx documentation
+# RMM, 15 Jan 2025
+
+FIGS = figures/classes.pdf
+RST_FIGS = figures/flatsys-steering-compare.png	\
+  figures/iosys-predprey-open.png				\
+  figures/timeplot-servomech-combined.png			\
+  figures/steering-optimal.png figures/ctrlplot-servomech.png	\
+  figures/phaseplot-dampedosc-default.png			\
+  figures/timeplot-mimo_step-default.png			\
+  figures/freqplot-siso_bode-default.png			\
+  figures/pzmap-siso_ctime-default.png				\
+  figures/rlocus-siso_ctime-default.png				\
+  figures/stochastic-whitenoise-response.png
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
@@ -12,18 +24,33 @@ BUILDDIR      = _build
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile doctest
+.PHONY: help Makefile html latexpdf doctest clean distclean
 
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-html latexpdf: Makefile doctest
-	make -C figures
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+# List of the first RST figure of each type in each file that is generated
+figures/flatsys-steering-compare.png: flatsys.rst
+figures/iosys-predprey-open.png: iosys.rst
+figures/timeplot-servomech-combined.png: nlsys.rst
+figures/steering-optimal.png: optimal.rst
+figures/phaseplot-dampedosc-default.png: phaseplot.rst
+figures/timeplot-mimo_step-default.png: response.rst
+figures/freqplot-siso_bode-default.png: response.rst
+figures/pzmap-siso_ctime-default.png: response.rst
+figures/rlocus-siso_ctime-default.png: response.rst
+figures/ctrlplot-servomech.png: response.rst
+figures/stochastic-whitenoise-response.png: stochastic.rst
 
-doctest: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+# Other figure rules
+figure/classes.pdf: figure/classes.fig
+	make -C figures classes.pdf
+
+# Rule to run `make doctest` once for all figures
+.docfigs: $(RST_FIGS)
+	@$(SPHINXBUILD) -M doctest "$(SOURCEDIR)" "$(BUILDDIR)"
+	touch $@
 
-clean:
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+html latexpdf doctest clean: Makefile .docfigs $(FIGS)
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 distclean: clean
