From 968abc7ebcb993e995fa2c57fb5ec9557d70e4a7 Mon Sep 17 00:00:00 2001 From: Sam James Date: Mon, 21 Oct 2024 21:31:42 +0100 Subject: [PATCH] feat: add sphinx autobuild --- Makefile | 6 +++++- requirements.txt | 1 + 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 298ea9e..b682f9e 100644 --- a/Makefile +++ b/Makefile @@ -4,6 +4,7 @@ # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build +SPHINXAUTOBUILD = sphinx-autobuild SOURCEDIR = . BUILDDIR = _build @@ -11,7 +12,10 @@ BUILDDIR = _build 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 index ce16eb6..717273d 100644 --- 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