blob: 4d721d30f363f00580a7ab7c26cae7880460631c [file] [log] [blame]
Andrew Geissleraf5e4ef2020-10-16 10:22:50 -05001# Minimal makefile for Sphinx documentation
Andrew Geissler4ed12e12020-06-05 18:00:41 -05002#
Patrick Williamsc124f4f2015-09-15 14:41:29 -05003
Andrew Geissleraf5e4ef2020-10-16 10:22:50 -05004# You can set these variables from the command line, and also
5# from the environment for the first two.
6SPHINXOPTS ?=
7SPHINXBUILD ?= sphinx-build
8SOURCEDIR = .
9BUILDDIR = _build
10DESTDIR = final
Brad Bishop316dfdd2018-06-25 12:45:53 -040011
Andrew Geissleraf5e4ef2020-10-16 10:22:50 -050012ifeq ($(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi),0)
13$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed")
Brad Bishop316dfdd2018-06-25 12:45:53 -040014endif
15
Andrew Geissleraf5e4ef2020-10-16 10:22:50 -050016# Put it first so that "make" without argument is like "make help".
17help:
18 @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Brad Bishop316dfdd2018-06-25 12:45:53 -040019
Andrew Geissleraf5e4ef2020-10-16 10:22:50 -050020.PHONY: help Makefile clean publish
Brad Bishop316dfdd2018-06-25 12:45:53 -040021
Andrew Geissleraf5e4ef2020-10-16 10:22:50 -050022publish: Makefile html singlehtml
23 rm -rf $(BUILDDIR)/$(DESTDIR)/
24 mkdir -p $(BUILDDIR)/$(DESTDIR)/
25 cp -r $(BUILDDIR)/html/* $(BUILDDIR)/$(DESTDIR)/
26 cp $(BUILDDIR)/singlehtml/index.html $(BUILDDIR)/$(DESTDIR)/singleindex.html
27 sed -i -e 's@index.html#@singleindex.html#@g' $(BUILDDIR)/$(DESTDIR)/singleindex.html
Patrick Williamsc124f4f2015-09-15 14:41:29 -050028
29clean:
Andrew Geissleraf5e4ef2020-10-16 10:22:50 -050030 @rm -rf $(BUILDDIR)
31
32# Catch-all target: route all unknown targets to Sphinx using the new
33# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
34%: Makefile
35 @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)