Merge pull request #75 from pyansys/feat/unit-tests

Solving workflow issues: vale, pre-commit

Author: RobPasMue

.github/workflows/ci_cd.yml

@@ -25,27 +25,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys code style checks
-        uses: pyansys/actions/code-style@v2
+        uses: pyansys/actions/code-style@v3
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
-  # docs-style:
-  #   name: Documentation Style Check
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v3
-
-  #     - name: Running Vale
-  #       uses: errata-ai/vale-action@reviewdog
-  #       env:
-  #         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-  #       with:
-  #         files: doc
-  #         reporter: github-pr-check
-  #         level: error
-  #         filter_mode: nofilter
-  #         fail_on_error: true
-  #         vale_flags: "--config=doc/.vale.ini"
+  docs-style:
+    name: Documentation Style Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: PyAnsys documentation style checks
+        uses: pyansys/actions/doc-style@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
 
   smoke-tests:
     name: Build and Smoke tests
@@ -55,11 +46,11 @@ jobs:
       fail-fast: false
       matrix:
         os: [windows-latest, ubuntu-latest]
-        python-version: ['3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.7', '3.8', '3.9', '3.10'] #, '3.11'] # --> At some point we should include Py3.11
 
     steps:
       - name: Build wheelhouse and perform smoke test
-        uses: pyansys/actions/build-wheelhouse@v2
+        uses: pyansys/actions/build-wheelhouse@v3
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           library-namespace: ${{ env.PACKAGE_NAMESPACE }}
@@ -69,7 +60,7 @@ jobs:
   docs:
     name: Documentation
     runs-on: ubuntu-latest
-    # needs: [docs-style]
+    needs: [docs-style]
     steps:
       - uses: actions/checkout@v3
 
@@ -103,7 +94,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Build library source and wheel artifacts
-        uses: pyansys/actions/build-library@v2
+        uses: pyansys/actions/build-library@v3
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
@@ -115,7 +106,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Release to GitHub
-        uses: pyansys/actions/release-github@v2
+        uses: pyansys/actions/release-github@v3
         with:
           library-name: ${{ env.PACKAGE_NAME }}
 
@@ -126,7 +117,7 @@ jobs:
     needs: [docs]
     steps:
       - name: Deploy the latest documentation
-        uses: pyansys/actions/doc-deploy-dev@v2
+        uses: pyansys/actions/doc-deploy-dev@v3
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
@@ -138,7 +129,7 @@ jobs:
     needs: [release]
     steps:
       - name: Deploy the stable documentation
-        uses: pyansys/actions/doc-deploy-stable@v2
+        uses: pyansys/actions/doc-deploy-stable@v3
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}

.pre-commit-config.yaml

@@ -14,7 +14,7 @@ exclude: |
 repos:
 
 - repo: https://github.com/psf/black
-  rev: 22.10.0
+  rev: 23.1.0
   hooks:
   - id: black
     args:
@@ -34,7 +34,7 @@ repos:
       - --max-line-length=120
 
 - repo: https://github.com/pycqa/isort
-  rev: 5.10.1
+  rev: 5.12.0
   hooks:
   - id: isort
     args:

doc/source/API/index.rst

@@ -3,7 +3,7 @@ API reference
 =============
 
 This section describes PyDyna core classes, methods, and functions
-for Dyna apps and modules. Use the search feature or click links
+for LS-Dyna apps and modules. Use the search feature or click links
 to view API documentation.
 
 .. toctree::

doc/source/API/pre.rst

@@ -1,5 +1,6 @@
 PyDyna-pre APIs
-================
+===============
+
 The PyDyna-pre API includes classes for apps and modules.
 
 .. currentmodule:: ansys.dyna.core

doc/source/Resources/Getting_Started.rst

@@ -1,13 +1,14 @@
-Getting Started
+Getting started
 ===============
 
 Installation
 ~~~~~~~~~~~~
+
 This package is not yet available on PyPI, so for now the only real
 option is for you to download the code from GitHub:
 
 .. code::
 
    git clone https://github.com/pyansys/pyDyna
 
-and copy the required files
+and copy the required files.

doc/source/Resources/User_Guide.rst

@@ -1,30 +1,30 @@
-User Guide
+User guide
 ----------
 
-There are 3 related packages here, all under the ansys/dyna/ directory.
+There are 3 related packages here, all under the ``ansys/dyna`` directory.
 
 PyDyna-pre provides interface to create DYNA input deck.
 
 PyDyna-solver contains code for interfacing with the LS-DYNA solver directly.
 As LS-DYNA is primarily a batch solver with very limited interactive
-capabilities, the code here is similarly limited.  The target
-use case is that LS-DYNA will be running in a container environment
-such as Docker or Kubernetes.  The code here then allows for pushing
+capabilities, the code here is similarly limited. The target
+use case is that LS-DYNA is running in a container environment
+such as Docker or Kubernetes. The code here then allows for pushing
 input files to the container, starting LS-DYNA and monitoring its
 progress, and retrieving results files.
 
 The Data Processing Framework (DPF) is designed to provide numerical
 simulation users/engineers with a toolbox for accessing and
 transforming simulation data. DPF can access data from solver result
-files as well as several neutral formats (csv, hdf5, vtk,
+files as well as several neutral formats (``.csv``, ``.hdf5``, ``.vtk``,
 etc.). Various operators are available allowing the manipulation and
 the transformation of this data.
 
 The Python `ansys-dpf-post` package provides a simplified Python
 interface to DPF, thus enabling rapid postprocessing without ever
-leaving a Python environment. 
+leaving a Python environment.
 
-Visit the [DPF-Post Documentation](https://postdocs.pyansys.com) for a
+Visit the `DPF-Post Documentation <https://post.docs.pyansys.com>`_ for a
 detailed description of the package
 
 .. toctree::