ci: configure doc snippets to run during CI/CD (#596)

Author: jwinkle8

.github/workflows/ci_cd_night.yml

@@ -219,6 +219,13 @@ jobs:
             ${{ env.STK_CONTAINER }} /bin/bash -c \
             "export COVERAGE_FILE=vgt && tox -e tests-vgt-graphics-cov-linux"
 
+      - name: "Run the doc snippet tests"
+        run: |
+          docker exec \
+            --workdir ${{ env.PYSTK_DIR }} \
+            ${{ env.STK_CONTAINER }} /bin/bash -c \
+            "export COVERAGE_FILE=snippets && tox -e tests-snippets-graphics-cov-linux"
+
       - name: "Install coverage dependencies"
         if: ${{ matrix.python == env.MAIN_PYTHON_VERSION }}
         run: |
@@ -233,7 +240,7 @@ jobs:
           docker exec \
             --workdir ${{ env.PYSTK_DIR }} \
             ${{ env.STK_CONTAINER }} /bin/bash -c \
-            "coverage combine aviator stknogfx stkgfx vgt"
+            "coverage combine aviator stknogfx stkgfx vgt snippets"
 
       - name: "Generate total coverage report"
         if: ${{ matrix.python == env.MAIN_PYTHON_VERSION }}

.github/workflows/ci_cd_pr.yml

@@ -400,6 +400,13 @@ jobs:
             ${{ env.STK_CONTAINER }} /bin/bash -c \
             "export COVERAGE_FILE=vgt && tox -e tests-vgt-graphics-cov-linux"
 
+      - name: "Run the doc snippet tests"
+        run: |
+          docker exec \
+            --workdir ${{ env.PYSTK_DIR }} \
+            ${{ env.STK_CONTAINER }} /bin/bash -c \
+            "export COVERAGE_FILE=snippets && tox -e tests-snippets-graphics-cov-linux"
+
       - name: "Install coverage dependencies"
         if: ${{ matrix.python == env.MINIMUM_PYTHON_VERSION }}
         run: |
@@ -414,7 +421,7 @@ jobs:
           docker exec \
             --workdir ${{ env.PYSTK_DIR }} \
             ${{ env.STK_CONTAINER }} /bin/bash -c \
-            "coverage combine aviator stknogfx stkgfx vgt"
+            "coverage combine aviator stknogfx stkgfx vgt snippets"
 
       - name: "Generate total coverage report"
         if: ${{ matrix.python == env.MINIMUM_PYTHON_VERSION }}

.github/workflows/ci_cd_release.yml

@@ -205,6 +205,13 @@ jobs:
             ${{ env.STK_CONTAINER }} /bin/bash -c \
             "export COVERAGE_FILE=vgt && tox -e tests-vgt-graphics-cov-linux"
 
+      - name: "Run the doc snippet tests"
+        run: |
+          docker exec \
+            --workdir ${{ env.PYSTK_DIR }} \
+            ${{ env.STK_CONTAINER }} /bin/bash -c \
+            "export COVERAGE_FILE=snippets && tox -e tests-snippets-graphics-cov-linux"
+
       - name: "Install coverage dependencies"
         if: ${{ matrix.python == env.MAIN_PYTHON_VERSION }}
         run: |
@@ -219,7 +226,7 @@ jobs:
           docker exec \
             --workdir ${{ env.PYSTK_DIR }} \
             ${{ env.STK_CONTAINER }} /bin/bash -c \
-            "coverage combine aviator stk vgt"
+            "coverage combine aviator stk vgt snippets"
 
       - name: "Generate total coverage report"
         if: ${{ matrix.python == env.MAIN_PYTHON_VERSION }}

tox.ini

@@ -51,6 +51,7 @@ setenv =
     aviator: PYTEST_PYTHON_FILES = ./tests/generated/aviator_tests
     stk: PYTEST_PYTHON_FILES = ./tests/generated/stk_tests
     vgt: PYTEST_PYTHON_FILES = ./tests/generated/vgt_tests
+    snippets: PYTEST_PYTHON_FILES = ./tests/doc_snippets_tests
 usedevelop = true
 extras = 
     tests