ci: checking documentation style in Examples directory too

.github/workflows/ci.yml

@@ -95,13 +95,18 @@ jobs:
 
 
   doc-style:
-    name: "Documentation style check"
+    name: "Documentation style ${{ matrix.folder }}"
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        folder: ["doc", "examples"]
     steps:
       - name: "Ansys documentation style checks"
         uses: ansys/actions/doc-style@v6
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+          files: ${{ matrix.folder }}
+          vale-config: ${{ matrix.folder }}/.vale.ini
           vale-version: "3.4.1"
 
 

doc/changelog.d/3191.changed.md

@@ -0,0 +1 @@
+ci: checking documentation style in ``Examples`` directory too

examples/.vale.ini

@@ -0,0 +1,36 @@
+# Core settings
+# =============
+
+# Location of our `styles`
+StylesPath = "../doc/styles"
+
+# The options are `suggestion`, `warning`, or `error` (defaults to “warning”).
+MinAlertLevel = warning
+
+# By default, `code` and `tt` are ignored.
+IgnoredScopes = code, tt
+
+# By default, `script`, `style`, `pre`, and `figure` are ignored.
+SkippedScopes = script, style, pre, figure
+
+# WordTemplate specifies what Vale will consider to be an individual word.
+WordTemplate = \b(?:%s)\b
+
+# List of Packages to be used for our guidelines
+Packages = Google
+
+# Define the Ansys vocabulary
+Vocab = ANSYS
+
+# Section styles
+# ============== 
+[*.{md,rst}]
+
+# Apply the following styles
+BasedOnStyles = Vale, Google
+
+TokenIgnores = (:(func|class|meth|attr|py):`(?:.|\n)*?`)|(<.*>)
+
+# Removing Google-specific rule - Not applicable under some circumstances
+Google.Colons = NO
+Vale.Terms = NO