Merge pull request #40 from JezSw/yslan/autobuild

add livehtml via sphinx-autobuild
JezSw · Oct 14, 2024 · 42103db · 42103db
2 parents 3fde755 + 77c554c
commit 42103db
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/doc/Makefile b/doc/Makefile
@@ -18,3 +18,6 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+livehtml: html
+	SKIPDOXYGEN=1 sphinx-autobuild --no-initial --re-ignore '.*\.swp' --ignore source/doxygen "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -2,4 +2,5 @@ Sphinx==7.2.6
 breathe==4.35.0
 sphinx-rtd-theme==2.0.0
 sphinx-tabs==3.4.5
-sphinx_mdinclude==0.6.0
+sphinx_mdinclude==0.6.0
+sphinx-autobuild
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -19,7 +19,7 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
-
+import os
 from os import makedirs, path
 from datetime import date
 import subprocess
@@ -235,5 +235,8 @@ def build_doxygen(app):
 
 
 def setup(app):
-    app.connect("builder-inited", build_doxygen)
+    skipDoxygen = os.getenv("SKIPDOXYGEN")
+    if skipDoxygen is None or skipDoxygen==0:
+        app.connect("builder-inited", build_doxygen)
+
     pass