ansys · RobPasMue · Apr 16, 2024 · Apr 15, 2024 · Apr 15, 2024 · Apr 15, 2024
diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
@@ -34,7 +34,7 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           vale-config: "doc/.vale.ini"
-          vale-version: "2.29.6"
+          vale-version: "3.1.0"
 
   doc-build:
     name: "Build project documentation"

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -35,7 +35,7 @@ repos:
   rev: v2.2.6
   hooks:
   - id: codespell
-    args: ["--ignore-words", "doc/styles/Vocab/ANSYS/accept.txt"]
+    args: ["--ignore-words", "doc/styles/config/vocabularies/ANSYS/accept.txt"]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.6.0

diff --git a/doc/.vale.ini b/doc/.vale.ini
@@ -2,7 +2,7 @@
 # =============
 
 # Location of our `styles`
-StylesPath = "styles"
+StylesPath = styles
 
 # The options are `suggestion`, `warning`, or `error` (defaults to “warning”).
 MinAlertLevel = warning
@@ -23,7 +23,6 @@ Packages = Google
 Vocab = ANSYS
 
 [*.{rst}]
-
 # Apply the following styles
 BasedOnStyles = Vale, Google
 Vale.Terms = NO

diff --git a/doc/source/coding-style/required-standard.rst b/doc/source/coding-style/required-standard.rst
@@ -35,7 +35,7 @@ Required ``pyproject.toml`` file configuration
     [tool.pydocstyle]
     convention = "numpy"
 
-Required Flake8 configuration
+Required flake8 configuration
 -----------------------------
 
 The following ``.flake8`` file is also required:

diff --git a/doc/source/content-writing/examples-writers/sphinx-gallery.rst b/doc/source/content-writing/examples-writers/sphinx-gallery.rst
@@ -1,6 +1,6 @@
 .. _sphinx-gallery:
 
-Use Sphinx-Gallery
+Use sphinx-gallery
 ==================
 
 The `sphinx_gallery <Sphinx_ext_sphinx_gallery_>`_ extension (Sphinx-Gallery) is

diff --git a/doc/source/content-writing/rst-files-writers/index.rst b/doc/source/content-writing/rst-files-writers/index.rst
@@ -77,8 +77,8 @@ For more information on RST file setup, see :ref:`rst_files_developers` and
 
 .. _readme_files:
 
-README files
-------------
+``README.rst`` files
+--------------------
 
 Each PyAnsys repository has a README file in its root directory that explains the
 project and points readers to the documentation. The README file can be an RST file

diff --git a/doc/source/how-to/releasing.rst b/doc/source/how-to/releasing.rst
@@ -436,10 +436,10 @@ You can download artifacts from the Ansys private PyPI, public PyPI, and GitHub.
 
 .. dropdown:: Download artifacts from the Ansys private PyPI
 
-    Request the value of the ``PYANSYS_PYPI_PRIVATE_PAT`` token by sending an
+    Request the value of the ``PYANSYS_PYPI_PRIVATE_READ_PAT`` token by sending an
     email to the `pyansys.core@ansys.com <pyansys.core@ansys.com>`_ email.
 
-    Create an environment variable named ``PYANSYS_PYPI_PRIVATE_PAT`` in your
+    Create an environment variable named ``PYANSYS_PYPI_PRIVATE_READ_PAT`` in your
     local machine an assign it the value of the token.
 
     .. warning::
@@ -466,22 +466,22 @@ You can download artifacts from the Ansys private PyPI, public PyPI, and GitHub.
 
                     .. code-block:: bat
 
-                        set PYANSYS_PYPI_PRIVATE_PAT=<REDACTED>
-                        set INDEX_URL=https://%PYANSYS_PYPI_PRIVATE_PAT%@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/
+                        set PYANSYS_PYPI_PRIVATE_READ_PAT=<REDACTED>
+                        set INDEX_URL=https://%PYANSYS_PYPI_PRIVATE_READ_PAT%@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/
                         python -m pip install ansys-<product/tool>-<library> --index-url %INDEX_URL% --no-dependencies
 
                 .. tab-item:: PowerShell
 
                     .. code-block:: powershell
 
-                        $env:INDEX_URL='https://$PYANSYS_PYPI_PRIVATE_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/'
+                        $env:INDEX_URL='https://$PYANSYS_PYPI_PRIVATE_READ_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/'
                         python -m pip install ansys-<product/tool>-<library> --index-url $env:INDEX_URL --no-dependencies
 
         .. tab-item:: macOS
 
             .. code-block:: text
 
-                export INDEX_URL='https://$PYANSYS_PYPI_PRIVATE_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/'
+                export INDEX_URL='https://$PYANSYS_PYPI_PRIVATE_READ_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/'
 
                 python -m pip install ansys-<product/tool>-<library> \
                 --index-url $INDEX_URL \
@@ -491,7 +491,7 @@ You can download artifacts from the Ansys private PyPI, public PyPI, and GitHub.
 
             .. code-block:: text
 
-                export INDEX_URL='https://$PYANSYS_PYPI_PRIVATE_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/'
+                export INDEX_URL='https://$PYANSYS_PYPI_PRIVATE_READ_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/'
 
                 python -m pip install ansys-<product/tool>-<library> \
                 --index-url $INDEX_URL \

diff --git a/doc/source/packaging/build-systems.rst b/doc/source/packaging/build-systems.rst
@@ -86,7 +86,7 @@ The combination of PEP 517 and PEP 518 leads to the following syntax in a
    requires = ["flit"] # Defined by PEP 518
    build-backend = "flit_core.api" # Defined by PEP 517
 
-build-backend tools
+Build-backend tools
 ===================
 
 This section lists some of the most popular build systems in the

diff --git a/doc/styles/.gitignore b/doc/styles/.gitignore
@@ -1,4 +1,4 @@
 *
-!Vocab
-!Vocab/**
+!vocabularies
+!vocabularies/**
 !.gitignore
diff --git a/doc/styles/Vocab/ANSYS/accept.txt → ...yles/config/vocabularies/ANSYS/accept.txt b/doc/styles/Vocab/ANSYS/accept.txt → ...yles/config/vocabularies/ANSYS/accept.txt
@@ -9,6 +9,7 @@ Brinkrolf
 CI/CD
 CLI
 CNAME
+CSV
 Codespell
 [Cc]omponentization
 [Cc]omponentizing

diff --git a/doc/styles/Vocab/ANSYS/reject.txt → ...yles/config/vocabularies/ANSYS/reject.txt b/doc/styles/Vocab/ANSYS/reject.txt → ...yles/config/vocabularies/ANSYS/reject.txt
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,7 @@ Brinkrolf @@
     CI/CD
     CLI
     CNAME
+    CSV
     Codespell
     [Cc]omponentization
     [Cc]omponentizing
@@ Expand Down @@