Add make autobuild to rebuild and reload HTML files in your browser (#1208)

Author: hugovk

Makefile

@@ -25,6 +25,7 @@ help:
 	@echo "  venv       to create a venv with necessary tools"
 	@echo "  html       to make standalone HTML files"
 	@echo "  htmlview   to open the index page built by the html target in your browser"
+	@echo "  autobuild  to rebuild and reload HTML files in your browser"
 	@echo "  clean      to remove the venv and build files"
 	@echo "  dirhtml    to make HTML files named index.html in directories"
 	@echo "  singlehtml to make a single large HTML file"
@@ -158,6 +159,11 @@ doctest: html
 htmlview: html
 	$(PYTHON) -c "import os, webbrowser; webbrowser.open('file://' + os.path.realpath('_build/html/index.html'))"
 
+.PHONY: autobuild
+autobuild: SPHINXBUILD = $(VENVDIR)/bin/sphinx-autobuild
+autobuild: SPHINXOPTS = --re-ignore="/\.idea/|/venv/"
+autobuild: html
+
 .PHONY: check
 check: ensure-venv
 	# Ignore the tools and venv dirs and check that the default role is not used.

requirements.txt

@@ -1,9 +1,10 @@
-Sphinx~=7.2.6
 furo>=2022.6.4
 jinja2
+sphinx-autobuild
 sphinx-inline-tabs>=2023.4.21
 sphinx-lint==0.6.8
 sphinx-notfound-page>=1.0.0
 sphinx_copybutton>=0.3.3
 sphinxext-opengraph>=0.7.1
 sphinxext-rediraffe
+Sphinx~=7.2.6