chore: add doc sub check workflow

angrybayblade · Oct 30, 2023 · 47f445c · 47f445c
1 parent 15a060b
commit 47f445c
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml
@@ -63,6 +63,8 @@ jobs:
         run: tox -e mypy
       - name: Pylint
         run: tox -e pylint
+      - name: Documentation checks
+        run: tox -e docs-block-check
 
   test:
     continue-on-error: True

diff --git a/tox.ini b/tox.ini
@@ -76,6 +76,20 @@ deps =
 commands =
     python -m mkdocs serve
 
+[testenv:docs-block-sub]
+basepython = python3.10
+deps =
+    mkdocs==1.5.3
+commands =
+    python {toxinidir}/scripts/sub_doc_blocks.py
+
+[testenv:docs-block-check]
+basepython = python3.10
+deps =
+    mkdocs==1.5.3
+commands =
+    python {toxinidir}/scripts/sub_doc_blocks.py --check
+
 [testenv:unittests]
 setenv =
     PYTHONPATH={env:PWD:%CD%}