[PATCH 1/8] build: add make livehtml target to run sphinx-autobuild

Jani Nikula jani.nikula at intel.com
Tue Oct 25 10:19:57 UTC 2022


sphinx-autobuild [1], when available, lets you run a local development
server that automatically rebuilds Sphinx documentation on changes in
the filesystem, with live-reload in the browser. This makes editing
documentation a slightly nicer experience.

Add livehtml target to run the server.

[1] https://pypi.org/project/sphinx-autobuild/
---
 Makefile | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Makefile b/Makefile
index 593756012ce4..d4c60d9d7b7f 100644
--- a/Makefile
+++ b/Makefile
@@ -117,3 +117,6 @@ doctest:
 .PHONY: doccheck
 doccheck:
 	$(SPHINXBUILD) -EWnq -b html $(ALLSPHINXOPTS) $(BUILDDIR)/doccheck
+
+livehtml:
+	sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
-- 
2.34.1



More information about the dim-tools mailing list