diff --git a/documentation/Makefile b/documentation/Makefile index 9645f067cad82aedcf22437a7ba1523d6c4dbaa0..915797508a0a062908c8251044a59437839ba67e 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -4,6 +4,8 @@ # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build +SPHINXAUTOBUILD = sphinx-autobuild +SPHINXAUTOBUILDOPT = --ignore .\#* PAPER = BUILDDIR = _build ROOT_DIR := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST)))) @@ -26,6 +28,7 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . help: @echo "Please use \`make <target>' where <target> is one of" @echo " html to make standalone HTML files" + @echo " autohtml to make start a watch and rebuild the documentation when a change is detected (https://github.com/GaretJax/sphinx-autobuild)." @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @@ -56,6 +59,11 @@ html: @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." +autohtml: + $(SPHINXAUTOBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html $(SPHINXAUTOBUILDOPT) + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo