blob: d40f390e2bb668ee7b1af22ab9700e91dcf0c87a [file] [log] [blame]
Patrick Williamsbf91d302021-01-30 08:17:16 -06001# Minimal makefile for Sphinx documentation
Patrick Williamsc124f4f2015-09-15 14:41:29 -05002#
Patrick Williamsc124f4f2015-09-15 14:41:29 -05003
Patrick Williamsbf91d302021-01-30 08:17:16 -06004# You can set these variables from the command line, and also
5# from the environment for the first two.
6SPHINXOPTS ?= -j auto
7SPHINXBUILD ?= sphinx-build
8SOURCEDIR = .
9BUILDDIR = _build
10DESTDIR = final
Brad Bishop316dfdd2018-06-25 12:45:53 -040011
Patrick Williamsbf91d302021-01-30 08:17:16 -060012ifeq ($(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
Patrick Williamsbf91d302021-01-30 08:17:16 -060016# 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
Patrick Williamsbf91d302021-01-30 08:17:16 -060020.PHONY: help Makefile clean publish
Brad Bishop316dfdd2018-06-25 12:45:53 -040021
Patrick Williamsbf91d302021-01-30 08:17:16 -060022publish: 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:
Patrick Williamsbf91d302021-01-30 08:17:16 -060030 @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)