Merge pull request #24 from SamJUK/feature/autobuild

feat: add sphinx autobuild
wardenenv · Oct 24, 2024 · d4f6d54 · d4f6d54
2 parents 26db50d + 968abc7
commit d4f6d54
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -4,14 +4,18 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
+SPHINXAUTOBUILD = sphinx-autobuild
 SOURCEDIR     = .
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+.PHONY: help Makefile watch
+
+watch:
+	@$(SPHINXAUTOBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(0)
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,5 @@
 sphinx>=5.0.0,<6.0.0
+sphinx-autobuild==2024.10.3
 sphinx_rtd_theme>=1.0.0,<2.0
 myst-parser>=0.18.0,<1.0
 sphinx-copybutton>=0.2.11,<1.0