fix: run examples in pipelines (#1040)

Co-authored-by: mhoeijm <[email protected]>
Co-authored-by: pyansys-ci-bot <[email protected]>

Author: 3 people

.github/workflows/ci_cd_main.yml

@@ -40,6 +40,17 @@ jobs:
           uv tool install tox --with tox-uv
 
       - name: "Build documentation"
+        env:
+          PYANSYS_HEART_FLUENT_VERSION: 24.1
+          PYFLUENT_LAUNCH_CONTAINER: 0
+          PYANSYS_HEART_LSDYNA_PATH: C:\Program Files\ANSYS Inc\LS-DYNA\R16.0\windows\R16.0.exe
+          PYANSYS_HEART_LSDYNA_PLATFORM: windows
+          PYANSYS_HEART_LSDYNA_TYPE: "smp"
+          LSTC_LICENSE: ansys
+          AWP_ROOT241: C:\\Program Files\\ANSYS Inc\\v241
+          DPF_STANDALONE_PATH: C:\\Program Files\\ANSYS Inc\\dpf-server-2024.2rc0
+          PYFLUENT_UI_MODE: no_gui # default hidden_gui fails on self-hosted runner
+          NIGHTLY_DOC_BUILD: 0
         run: |
           tox -e doc-links,doc-html,doc-pdf
 

.github/workflows/ci_cd_night.yml

@@ -76,9 +76,18 @@ jobs:
        run: |
          uv tool run tox -e tests -x testenv.deps+="-e dpf-standalone/v${{ env.ANSYS_VERSION }}" -- -m "${{ matrix.tests.markers }}" -vv
 
+  doc-style:
+    name: Documentation Style Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ansys/actions/doc-style@4f15ff3ab1183912ce862d51b8c66ea124b052a1 # v9.0.2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
   doc-build:
     name: "Build documentation"
     runs-on: [self-hosted, pyhealth]
+    needs: doc-style
     steps:
 
       - name: "Checkout the project"
@@ -94,6 +103,17 @@ jobs:
           uv tool install tox --with tox-uv
 
       - name: "Build documentation"
+        env:
+          PYANSYS_HEART_FLUENT_VERSION: 24.1
+          PYFLUENT_LAUNCH_CONTAINER: 0
+          PYANSYS_HEART_LSDYNA_PATH: C:\Program Files\ANSYS Inc\LS-DYNA\R16.0\windows\R16.0.exe
+          PYANSYS_HEART_LSDYNA_PLATFORM: windows
+          PYANSYS_HEART_LSDYNA_TYPE: "smp"
+          LSTC_LICENSE: ansys
+          AWP_ROOT241: C:\\Program Files\\ANSYS Inc\\v241
+          DPF_STANDALONE_PATH: C:\\Program Files\\ANSYS Inc\\dpf-server-2024.2rc0
+          PYFLUENT_UI_MODE: no_gui # default hidden_gui fails on self-hosted runner
+          NIGHTLY_DOC_BUILD: 0
         run: |
           tox -e doc-links,doc-html,doc-pdf
 

.github/workflows/ci_cd_pr.yml

@@ -115,6 +115,17 @@ jobs:
           uv tool install tox --with tox-uv
 
       - name: "Build documentation"
+        env:
+          PYANSYS_HEART_FLUENT_VERSION: 24.1
+          PYFLUENT_LAUNCH_CONTAINER: 0
+          PYANSYS_HEART_LSDYNA_PATH: C:\Program Files\ANSYS Inc\LS-DYNA\R16.0\windows\R16.0.exe
+          PYANSYS_HEART_LSDYNA_PLATFORM: windows
+          PYANSYS_HEART_LSDYNA_TYPE: "smp"
+          LSTC_LICENSE: ansys
+          AWP_ROOT241: C:\\Program Files\\ANSYS Inc\\v241
+          DPF_STANDALONE_PATH: C:\\Program Files\\ANSYS Inc\\dpf-server-2024.2rc0
+          PYFLUENT_UI_MODE: no_gui # default hidden_gui fails on self-hosted runner
+          NIGHTLY_DOC_BUILD: 0
         run: |
           tox -e doc-links,doc-html,doc-pdf
 

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ repos:
   rev: v2.4.1
   hooks:
   - id: codespell
-    exclude: ^(tests/heart/assets\/)
+    exclude: ^(tests/heart/assets.*|src/ansys/health/heart/data_examples.*)
     args: [-L solf, "--ignore-words", "doc/styles/config/vocabularies/ANSYS/accept.txt", "-w"]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks