sphinx-autobuild for live docs updates (#129)

* `sphinx-autobuild` for live docs updates.

* Use Python 3.9 and `sphinx-autobuild` `2024.2.4`

Author: reedsa

.circleci/config.yml

@@ -99,7 +99,7 @@ jobs:
   docs:
     <<: *docs
     docker:
-      - image: cimg/python:3.8
+      - image: cimg/python:3.9
         environment:
           TOXENV: docs
 

.readthedocs.yaml

@@ -3,7 +3,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.8"
+    python: "3.9"
 
 sphinx:
   configuration: docs/conf.py

Makefile

@@ -8,6 +8,7 @@ help:
 	@echo "lint - fix linting issues with pre-commit"
 	@echo "test - run tests quickly with the default Python"
 	@echo "docs - generate docs and open in browser (linux-docs for version on linux)"
+	@echo "autobuild-docs - live update docs when changes are saved"
 	@echo "notes - consume towncrier newsfragments/ and update release notes in docs/"
 	@echo "release - package and upload a release (does not run notes target)"
 	@echo "dist - package"
@@ -33,6 +34,9 @@ lint:
 test:
 	pytest tests
 
+autobuild-docs:
+	sphinx-autobuild --open-browser docs docs/_build/html
+
 build-docs:
 	sphinx-apidoc -o docs/ . setup.py "*conftest*"
 	$(MAKE) -C docs clean

setup.py

@@ -17,6 +17,7 @@
     ],
     "docs": [
         "sphinx>=6.0.0",
+        "sphinx-autobuild>=2024.2.4",
         "sphinx_rtd_theme>=1.0.0",
         "towncrier>=21,<22",
     ],