Add vale documentation check (#302)

* Add pyansys doc checking * Add vocab and file ignores * Additional corrections * Update .github/workflows/ci_cd.yml
ansys · Dec 30, 2022 · 5e56553 · 5e56553
1 parent ec96dce
commit 5e56553
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 3 deletions.
diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
@@ -33,7 +33,16 @@ jobs:
       - name: Lint project
         run: |
           tox -e lint
-          
+
+  docs-style:
+    name: Documentation Style Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: PyAnsys documentation style checks
+        uses: pyansys/actions/doc-style@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
   test:
     name: Unit test on supported platforms
     runs-on: ubuntu-latest

diff --git a/doc/source/_static/README.md b/doc/source/_static/README.md
@@ -1 +1 @@
-You will find static files (like images and other assets) here.
+Find static files (like images and other assets) here.
diff --git a/doc/source/_templates/custom-class-template.rst b/doc/source/_templates/custom-class-template.rst
@@ -1,3 +1,5 @@
+.. vale off
+
 {{ fullname | escape | underline}}
 
 .. currentmodule:: {{ module }}
@@ -32,3 +34,5 @@
    {%- endfor %}
    {% endif %}
    {% endblock %}
+
+.. vale on
diff --git a/doc/source/_templates/custom-module-template.rst b/doc/source/_templates/custom-module-template.rst
@@ -1,3 +1,5 @@
+.. vale off
+
 {{ fullname | escape | underline}}
 
 .. automodule:: {{ fullname }}
@@ -64,3 +66,5 @@
 {%- endfor %}
 {% endif %}
 {% endblock %}
+
+.. vale on
diff --git a/doc/styles/Vocab/ANSYS/accept.txt b/doc/styles/Vocab/ANSYS/accept.txt
@@ -2,4 +2,7 @@ ANSYS
 Ansys
 ansys
 OpenAPI
-OpenAPI-Common
+OpenAPI-Common
+Kerberos
+Heimdal
+APIs