tools: add sphinx-autobuild

canonical · Feb 3, 2023 · 34e0222 · 34e0222
1 parent ec396df
commit 34e0222
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/pyproject.toml b/pyproject.toml
@@ -25,13 +25,14 @@ dev = [
 types = [
 ]
 docs = [
+    "furo==2022.12.07",
     "sphinx==5.3.0",
+    "sphinx-autobuild==2021.3.14",
     "sphinx-copybutton==0.5.1",
     "sphinx-design==0.3.0",
     "sphinx-pydantic==0.1.1",
     "sphinx-toolbox==3.4.0",
     "sphinx-lint==0.6.7",
-    "furo==2022.12.07",
 ]
 
 [build-system]

diff --git a/tox.ini b/tox.ini
@@ -127,6 +127,11 @@ commands_pre = bash -c 'if [[ ! -e docs ]];then echo "No docs directory. Run `to
 # "-W" is to treat warnings as errors
 commands = sphinx-build {posargs:-b html} -W {tox_root}/docs {tox_root}/docs/_build
 
+[testenv:rundocs]
+description = Build documentation with an autoupdating server
+base = docs
+commands = sphinx-autobuild {posargs:-b html --open-browser --port 8080} -W --watch {tox_root}/starcraft {tox_root}/docs {tox_root}/docs/_build
+
 [testenv:lint-docs]
 description = Lint the documentation with sphinx-lint
 base = docs