MAINT: write sphinx-build flags full

ComPWA · Sep 11, 2024 · de8b849 · de8b849
1 parent b683dc9
commit de8b849
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 19 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -288,19 +288,22 @@ pydeps tensorwaves \
 [tool.pixi.feature.dev.tasks.doc]
 cmd = """
 sphinx-build \
+    --builder dirhtml \
+    --fail-on-warning \
     --keep-going \
-    -TW \
-    -b dirhtml \
+    --show-traceback \
     docs/ docs/_build/html
 """
 env = {FORCE_COLOR = "yes"}
 
 [tool.pixi.feature.dev.tasks.doclive]
 cmd = """
 sphinx-autobuild \
+    --builder dirhtml \
     --open-browser \
-    --re-ignore '.*/.ipynb_checkpoints/.*' \
     --re-ignore '.*/__pycache__/.*' \
+    --re-ignore '.*/.ipynb_checkpoints/.*' \
+    --re-ignore 'docs/_build/.*' \
     --re-ignore 'docs/.*\\.csv' \
     --re-ignore 'docs/.*\\.gif' \
     --re-ignore 'docs/.*\\.gv' \
@@ -311,13 +314,11 @@ sphinx-autobuild \
     --re-ignore 'docs/.*\\.svg' \
     --re-ignore 'docs/.*\\.yaml' \
     --re-ignore 'docs/.*\\.yml' \
-    --re-ignore 'docs/_build/.*' \
     --re-ignore 'docs/api/.*' \
     --re-ignore 'docs/usage/logs/.*' \
     --re-ignore docs/usage/sub_expr_f? \
     --watch docs \
     --watch src \
-    -b dirhtml \
     docs/ docs/_build/html
 """
 env = {FORCE_COLOR = "yes"}
@@ -341,8 +342,8 @@ pytest  \
 [tool.pixi.feature.dev.tasks.linkcheck]
 cmd = """
 sphinx-build \
-    -T \
-    -b linkcheck \
+    --builder linkcheck \
+    --show-traceback \
     docs/ docs/_build/linkcheck
 """
 env = {FORCE_COLOR = "yes"}

diff --git a/tox.ini b/tox.ini
@@ -49,9 +49,10 @@ allowlist_externals =
   sphinx-build
 commands =
   sphinx-build \
+    --builder dirhtml \
+    --fail-on-warning \
     --keep-going \
-    -TW \
-    -b dirhtml \
+    --show-traceback \
     docs/ docs/_build/html
 description =
   Build documentation and API through Sphinx
@@ -64,9 +65,11 @@ allowlist_externals =
   sphinx-autobuild
 commands =
   sphinx-autobuild \
+    --builder dirhtml \
     --open-browser \
-    --re-ignore .*/.ipynb_checkpoints/.* \
     --re-ignore .*/__pycache__/.* \
+    --re-ignore .*/.ipynb_checkpoints/.* \
+    --re-ignore docs/_build/.* \
     --re-ignore docs/.*\.csv \
     --re-ignore docs/.*\.gif \
     --re-ignore docs/.*\.gv \
@@ -77,13 +80,11 @@ commands =
     --re-ignore docs/.*\.svg \
     --re-ignore docs/.*\.yaml \
     --re-ignore docs/.*\.yml \
-    --re-ignore docs/_build/.* \
     --re-ignore docs/api/.* \
     --re-ignore docs/usage/logs/.* \
     --re-ignore docs/usage/sub_expr_f? \
     --watch docs \
     --watch src \
-    -b dirhtml \
     docs/ docs/_build/html
 description =
   Set up a server to directly preview changes to the HTML pages
@@ -96,9 +97,10 @@ allowlist_externals =
   sphinx-build
 commands =
   sphinx-build \
+    --builder dirhtml \
+    --fail-on-warning \
     --keep-going \
-    -TW \
-    -b dirhtml \
+    --show-traceback \
     docs/ docs/_build/html
 description =
   Build documentation through Sphinx WITH output of Jupyter notebooks
@@ -112,9 +114,11 @@ allowlist_externals =
   sphinx-autobuild
 commands =
   sphinx-autobuild \
+    --builder dirhtml \
     --open-browser \
-    --re-ignore .*/.ipynb_checkpoints/.* \
     --re-ignore .*/__pycache__/.* \
+    --re-ignore .*/.ipynb_checkpoints/.* \
+    --re-ignore docs/_build/.* \
     --re-ignore docs/.*\.csv \
     --re-ignore docs/.*\.gif \
     --re-ignore docs/.*\.gv \
@@ -125,13 +129,11 @@ commands =
     --re-ignore docs/.*\.svg \
     --re-ignore docs/.*\.yaml \
     --re-ignore docs/.*\.yml \
-    --re-ignore docs/_build/.* \
     --re-ignore docs/api/.* \
     --re-ignore docs/usage/logs/.* \
     --re-ignore docs/usage/sub_expr_f? \
     --watch docs \
     --watch src \
-    -b dirhtml \
     docs/ docs/_build/html
 description =
   Set up a server to directly preview changes to the HTML pages
@@ -165,8 +167,8 @@ allowlist_externals =
   sphinx-build
 commands =
   sphinx-build \
-    -T \
-    -b linkcheck \
+    --builder linkcheck \
+    --show-traceback \
     docs/ docs/_build/linkcheck
 description =
   Check external links in the documentation (requires internet connection)