Add: Allow to auto re-build the docs on changes via livehtml

Introduce a new makefile target livehtml that re-builds the docs automatically via the sphinx-autobuild package in the background.
greenbone · Sep 1, 2023 · cfc22ea · cfc22ea
1 parent ed2e5fc
commit cfc22ea
Show file tree

Hide file tree

Showing 3 changed files with 79 additions and 32 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -11,7 +11,10 @@ BUILDDIR      = build
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+livehtml:
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile livehtml
 
 # 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
@@ -52,6 +52,7 @@ sphinx = "^5.3.0"
 coverage = "^7.2"
 rope = "^1.9.0"
 furo = "^2023.3.27"
+sphinx-autobuild = ">=2021.3.14"
 
 [tool.black]
 line-length = 80