wip: sphinx-autobuild

canonical · Aug 20, 2024 · 0a4ff80 · 0a4ff80
1 parent 7a5513a
commit 0a4ff80
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -2,9 +2,9 @@
 import sys
 import os
 
-sys.path.append('./')
+sys.path.append(os.path.abspath('.'))
 from custom_conf import *
-sys.path.append('.sphinx/')
+sys.path.append(os.path.abspath('.sphinx/'))
 from build_requirements import *
 
 # Configuration file for the Sphinx documentation builder.

diff --git a/tox.ini b/tox.ini
@@ -37,6 +37,16 @@ commands_pre =
 commands =
     sphinx-build -W --keep-going docs/ docs/_build/html
 
+[testenv:docs-live]
+description = Live development: build the Sphinx docs with autoreloading enabled
+deps =
+    {[testenv:docs]deps}
+    sphinx-autobuild
+commands_pre =
+    {[testenv:docs]commands_pre}
+commands =
+    sphinx-autobuild docs/ docs/_build/html --watch docs --port 8000
+
 [testenv:fmt]
 description = Apply coding style standards to code
 deps =