From 03e7871afdb8f558cddc10cc9013e1db143298d9 Mon Sep 17 00:00:00 2001
From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Date: Sun, 20 Apr 2025 00:18:01 +0300
Subject: [PATCH] Add `make [-C docs] htmllive` to rebuild and reload HTML
 files (#8913)

Co-authored-by: Andrew Murray <3112309+radarhere@users.noreply.github.com>
---
 Makefile       |  5 +++++
 docs/Guardfile | 10 ----------
 docs/Makefile  |  9 +++++----
 pyproject.toml |  1 +
 4 files changed, 11 insertions(+), 14 deletions(-)
 delete mode 100755 docs/Guardfile

diff --git a/Makefile b/Makefile
index 53164b08a..5a8152454 100644
--- a/Makefile
+++ b/Makefile
@@ -23,6 +23,10 @@ doc html:
 htmlview:
 	$(MAKE) -C docs htmlview
 
+.PHONY: htmllive
+htmllive:
+	$(MAKE) -C docs htmllive
+
 .PHONY: doccheck
 doccheck:
 	$(MAKE) doc
@@ -43,6 +47,7 @@ help:
 	@echo "  docserve           run an HTTP server on the docs directory"
 	@echo "  html               make HTML docs"
 	@echo "  htmlview           open the index page built by the html target in your browser"
+	@echo "  htmllive           rebuild and reload HTML files in your browser"
 	@echo "  install            make and install"
 	@echo "  install-coverage   make and install with C coverage"
 	@echo "  lint               run the lint checks"
diff --git a/docs/Guardfile b/docs/Guardfile
deleted file mode 100755
index 16a891a73..000000000
--- a/docs/Guardfile
+++ /dev/null
@@ -1,10 +0,0 @@
-#!/usr/bin/env python3
-from __future__ import annotations
-
-from livereload.compiler import shell
-from livereload.task import Task
-
-Task.add("*.rst", shell("make html"))
-Task.add("*/*.rst", shell("make html"))
-Task.add("Makefile", shell("make html"))
-Task.add("conf.py", shell("make html"))
diff --git a/docs/Makefile b/docs/Makefile
index e90af0519..4412fc806 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -20,8 +20,8 @@ help:
 	@echo "Please use \`make <target>' where <target> is one of"
 	@echo "  html       to make standalone HTML files"
 	@echo "  htmlview   to open the index page built by the html target in your browser"
+	@echo "  htmllive   to rebuild and reload HTML files in your browser"
 	@echo "  serve      to start a local server for viewing docs"
-	@echo "  livehtml   to start a local server for viewing docs and auto-reload on change"
 	@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"
@@ -201,9 +201,10 @@ doctest:
 htmlview: html
 	$(PYTHON) -c "import os, webbrowser; webbrowser.open('file://' + os.path.realpath('$(BUILDDIR)/html/index.html'))"
 
-.PHONY: livehtml
-livehtml: html
-	livereload $(BUILDDIR)/html -p 33233
+.PHONY: htmllive
+htmllive: SPHINXBUILD = $(PYTHON) -m sphinx_autobuild
+htmllive: SPHINXOPTS = --open-browser --delay 0
+htmllive: html
 
 .PHONY: serve
 serve:
diff --git a/pyproject.toml b/pyproject.toml
index e8e76796a..a3ff9723b 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -44,6 +44,7 @@ optional-dependencies.docs = [
   "furo",
   "olefile",
   "sphinx>=8.2",
+  "sphinx-autobuild",
   "sphinx-copybutton",
   "sphinx-inline-tabs",
   "sphinxext-opengraph",