Add support for sphinx autobuild

Signed-off-by: Keshav Priyadarshi <[email protected]>

Author: keshav-space

docs/Makefile

@@ -5,6 +5,7 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
+SPHINXAUTOBUILD = sphinx-autobuild
 SOURCEDIR     = source
 BUILDDIR      = build
 
@@ -14,6 +15,13 @@ help:
 
 .PHONY: help Makefile
 
+# Run the development server using sphinx-autobuild
+docs:
+	@echo
+	@echo "Starting up the docs server..."
+	@echo
+	$(SPHINXAUTOBUILD) --port 8000 --watch ${SOURCEDIR} $(SOURCEDIR) "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

requirements.txt

@@ -101,6 +101,7 @@ snowballstemmer==2.2.0
 soupsieve==2.3.2
 Sphinx==4.5.0
 sphinxcontrib-applehelp==1.0.2
+sphinx-autobuild==2024.10.3
 sphinxcontrib-devhelp==1.0.2
 sphinxcontrib-django2==1.5
 sphinxcontrib-htmlhelp==2.0.0

setup.cfg

@@ -111,6 +111,7 @@ dev =
     Sphinx>=4.5.0
     sphinx_rtd_theme>=1.0.0
     sphinxcontrib-django2>=1.5
+    sphinx-autobuild>=2024.10.3
     # Tests
     pytest>=7.0.1
     pytest-django>=4.5.2