Add: Add sphinx- autobuild for rebuilding the docs automatically

cd docs && make livehtml can be used to start a web server that rebuilds the docs automatically if some file has changed.
greenbone · Mar 8, 2023 · 7f23202 · 7f23202
1 parent 421f019
commit 7f23202
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 2 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -12,7 +12,10 @@ BUILDDIR      = _build
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+.PHONY: help livehtml Makefile
+
+livehtml:
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(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).

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -54,6 +54,7 @@ coverage = "^7.2"
 myst-parser = "^0.19.1"
 Sphinx = "^5.3.0"
 furo = "^2022.12.7"
+sphinx-autobuild = "^2021.3.14"
 
 [tool.black]
 line-length = 80