From 47f445c683127b3f9c17e3960127bd770ddf996b Mon Sep 17 00:00:00 2001 From: angrybayblade Date: Mon, 30 Oct 2023 19:09:11 +0530 Subject: [PATCH] chore: add doc sub check workflow --- .github/workflows/workflow.yml | 2 ++ tox.ini | 14 ++++++++++++++ 2 files changed, 16 insertions(+) diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml index 4c10368..107d603 100644 --- 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 index e1e7b95..a2b76f6 100644 --- 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%}