ansys · PProfizi · Jan 15, 2024 · Jan 15, 2024 · Jan 15, 2024
diff --git a/.github/workflows/docs-style.yml b/.github/workflows/docs-style.yml
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -60,10 +60,12 @@ env:
 jobs:
   doc-style:
     name: "Check doc style"
-    uses: ./.github/workflows/docs-style.yml
-    with:
-      vale_reporter: ${{ (inputs.event_name == 'pull_request') && 'github-check' || 'local' }}
-    secrets: inherit
+    runs-on: ubuntu-latest
+    steps:
+        - name: "Running documentation style checks"
+          uses: ansys/actions/[email protected]
+          with:
+            token: ${{ secrets.GITHUB_TOKEN }}
 
   docs:
     name: "Documentation"
@@ -119,11 +121,11 @@ jobs:
         shell: bash
         run: |
           export SPHINX_APIDOC_OPTIONS=inherited-members
-          sphinx-apidoc -o docs/source/api src/ansys ${{inputs.build_extras}} -f --implicit-namespaces --separate --no-headings $DEBUG_SPHINX
+          sphinx-apidoc -o doc/source/api src/ansys ${{inputs.build_extras}} -f --implicit-namespaces --separate --no-headings $DEBUG_SPHINX
 
       - name: "Build HTML Documentation"
         shell: bash
-        working-directory: docs
+        working-directory: doc
         run: |
           export TEMP=${{ runner.temp }}
           make clean
@@ -132,7 +134,7 @@ jobs:
 
       - name: "Check for success"
         shell: bash
-        working-directory: docs
+        working-directory: doc
         run: |
           case `tail -n 5 log.txt | grep -F "build succeeded" >/dev/null; echo $?` in
           0)
@@ -148,7 +150,7 @@ jobs:
 
       - name: "Build PDF Documentation"
         shell: bash
-        working-directory: docs
+        working-directory: doc
         if: ${{ inputs.generate_pdf == 'true' }}
         run: |
           export TEMP=${{ runner.temp }}
@@ -159,13 +161,13 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: doc-${{env.PACKAGE_NAME}}-log
-          path: docs/*.txt
+          path: doc/*.txt
         if: always()
 
       - name: "Zip HTML Documentation"
         uses: vimtor/[email protected]
         with:
-          files: docs/build/html/
+          files: doc/build/html/
           dest: HTML-doc-${{env.PACKAGE_NAME}}.zip
         if: always()
 
@@ -180,7 +182,7 @@ jobs:
         shell: bash
         if: ${{ inputs.generate_pdf == 'true' }}
         id: pdf
-        working-directory: docs/build/latex
+        working-directory: doc/build/latex
         run: |
           pattern="PyDPF-*.pdf"
           files=( $pattern )
@@ -191,7 +193,7 @@ jobs:
         uses: vimtor/[email protected]
         if: ${{ inputs.generate_pdf == 'true' }}
         with:
-          files: docs/build/latex/${{ steps.pdf.outputs.PDF_file }}
+          files: doc/build/latex/${{ steps.pdf.outputs.PDF_file }}
           dest: PDF-doc-${{env.PACKAGE_NAME}}.zip
 
       - name: "Upload PDF Documentation"

diff --git a/.gitignore b/.gitignore
@@ -71,9 +71,9 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/build/
-docs/source/api/_autosummary
-docs/source/examples
+doc/build/
+doc/source/api/_autosummary
+doc/source/examples
 
 # PyBuilder
 .pybuilder/

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 exclude: |
     (?x)^(
-        docs/styles/
+        doc/styles/
     )
 repos:
 - repo: https://github.com/psf/black
@@ -28,7 +28,7 @@ repos:
   hooks:
   - id: codespell
     args: [
-      "docs src",
+      "doc src",
       "*.py *.rst *.md",
     ]
     exclude: conf.py

diff --git a/codecov.yml b/codecov.yml
@@ -15,5 +15,5 @@ coverage:
         if_no_uploads: error
   ignore:
     - "examples"  # ignore folder and all its contents
-    - "docs"  # ignore folder and all its contents
+    - "doc"  # ignore folder and all its contents
     - "tests"  # ignore folder and all its contents
diff --git a/docs/.vale.ini → doc/.vale.ini b/docs/.vale.ini → doc/.vale.ini
@@ -1,43 +1,43 @@
-# Core settings
-# =============
-
-# Location of our `styles`
-StylesPath = "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
-
-[*.{md,rst}]
-
-# Apply the following styles
-BasedOnStyles = Vale, Google
-
-# Removing Google-specific rule - Not applicable under some circumstances
-Google.WordList = NO
-Google.Colons = NO
-
-[formats]
-# Format associations appear under
-# the optional "formats" section.
-
-[*]
-# Format-specific settings appear
-# under a user-provided "glob"
-# pattern.
-TokenIgnores = (:.*:\x60.*\x60)
-
+# Core settings
+# =============
+
+# Location of our `styles`
+StylesPath = "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
+
+[*.{md,rst}]
+
+# Apply the following styles
+BasedOnStyles = Vale, Google
+
+# Removing Google-specific rule - Not applicable under some circumstances
+Google.WordList = NO
+Google.Colons = NO
+
+[formats]
+# Format associations appear under
+# the optional "formats" section.
+
+[*]
+# Format-specific settings appear
+# under a user-provided "glob"
+# pattern.
+TokenIgnores = (:.*:\x60.*\x60)
+
diff --git a/docs/Makefile → doc/Makefile b/docs/Makefile → doc/Makefile
diff --git a/docs/make.bat → doc/make.bat b/docs/make.bat → doc/make.bat
diff --git a/docs/source/api/index.rst → doc/source/api/index.rst b/docs/source/api/index.rst → doc/source/api/index.rst
diff --git a/docs/source/api/result_data.rst → doc/source/api/result_data.rst b/docs/source/api/result_data.rst → doc/source/api/result_data.rst
diff --git a/docs/source/api/result_object.rst → doc/source/api/result_object.rst b/docs/source/api/result_object.rst → doc/source/api/result_object.rst
diff --git a/docs/source/api/solution.rst → doc/source/api/solution.rst b/docs/source/api/solution.rst → doc/source/api/solution.rst
diff --git a/docs/source/conf.py → doc/source/conf.py b/docs/source/conf.py → doc/source/conf.py
diff --git a/docs/source/contributing.rst → doc/source/contributing.rst b/docs/source/contributing.rst → doc/source/contributing.rst
diff --git a/.../source/getting_started/compatibility.rst → doc/source/getting_started/compatibility.rst b/.../source/getting_started/compatibility.rst → doc/source/getting_started/compatibility.rst
diff --git a/docs/source/getting_started/index.rst → doc/source/getting_started/index.rst b/docs/source/getting_started/index.rst → doc/source/getting_started/index.rst
diff --git a/docs/source/getting_started/install.rst → doc/source/getting_started/install.rst b/docs/source/getting_started/install.rst → doc/source/getting_started/install.rst
diff --git a/docs/source/images/crankshaft_disp.png → doc/source/images/crankshaft_disp.png b/docs/source/images/crankshaft_disp.png → doc/source/images/crankshaft_disp.png
diff --git a/docs/source/images/crankshaft_stress.png → doc/source/images/crankshaft_stress.png b/docs/source/images/crankshaft_stress.png → doc/source/images/crankshaft_stress.png
diff --git a/docs/source/images/crankshaft_stress_xx.png → doc/source/images/crankshaft_stress_xx.png b/docs/source/images/crankshaft_stress_xx.png → doc/source/images/crankshaft_stress_xx.png
diff --git a/docs/source/images/dpf-flow.png → doc/source/images/dpf-flow.png b/docs/source/images/dpf-flow.png → doc/source/images/dpf-flow.png
diff --git a/docs/source/images/main_example.png → doc/source/images/main_example.png b/docs/source/images/main_example.png → doc/source/images/main_example.png
diff --git a/docs/source/index.rst → doc/source/index.rst b/docs/source/index.rst → doc/source/index.rst
diff --git a/docs/source/pydpf-post_clone_install.rst → doc/source/pydpf-post_clone_install.rst b/docs/source/pydpf-post_clone_install.rst → doc/source/pydpf-post_clone_install.rst
diff --git a/...ce/user_guide/accessing_file_metadata.rst → ...ce/user_guide/accessing_file_metadata.rst b/...ce/user_guide/accessing_file_metadata.rst → ...ce/user_guide/accessing_file_metadata.rst
diff --git a/docs/source/user_guide/accessing_results.rst → doc/source/user_guide/accessing_results.rst b/docs/source/user_guide/accessing_results.rst → doc/source/user_guide/accessing_results.rst
diff --git a/docs/source/user_guide/extending_to_core.rst → doc/source/user_guide/extending_to_core.rst b/docs/source/user_guide/extending_to_core.rst → doc/source/user_guide/extending_to_core.rst
diff --git a/docs/source/user_guide/index.rst → doc/source/user_guide/index.rst b/docs/source/user_guide/index.rst → doc/source/user_guide/index.rst
diff --git a/docs/source/user_guide/known_issues_list.rst → doc/source/user_guide/known_issues_list.rst b/docs/source/user_guide/known_issues_list.rst → doc/source/user_guide/known_issues_list.rst
diff --git a/docs/source/user_guide/plotting.rst → doc/source/user_guide/plotting.rst b/docs/source/user_guide/plotting.rst → doc/source/user_guide/plotting.rst
diff --git a/docs/source/user_guide/post_processing.rst → doc/source/user_guide/post_processing.rst b/docs/source/user_guide/post_processing.rst → doc/source/user_guide/post_processing.rst
diff --git a/docs/source/user_guide/server_context.rst → doc/source/user_guide/server_context.rst b/docs/source/user_guide/server_context.rst → doc/source/user_guide/server_context.rst
diff --git a/docs/source/user_guide/troubleshooting.rst → doc/source/user_guide/troubleshooting.rst b/docs/source/user_guide/troubleshooting.rst → doc/source/user_guide/troubleshooting.rst
diff --git a/docs/styles/.gitignore → doc/styles/.gitignore b/docs/styles/.gitignore → doc/styles/.gitignore
@@ -1,4 +1,4 @@
-*
-!Vocab
-!Vocab/**
+*
+!Vocab
+!Vocab/**
 !.gitignore
diff --git a/docs/styles/Vocab/ANSYS/accept.txt → doc/styles/Vocab/ANSYS/accept.txt b/docs/styles/Vocab/ANSYS/accept.txt → doc/styles/Vocab/ANSYS/accept.txt
@@ -1,17 +1,17 @@
-[Aa]nsys
-[Cc]ore
-[Pp]ost
-ANSYS
-API
-HDF5
-postprocess
-postprocessing
-(PyDPF\s|PyDPF-Core|PyDPF-Post)
-Pythonic
-R1
-R2
-subresult
-subresults
-Thermal/electric
-UTF-8
-VTK
+[Aa]nsys
+[Cc]ore
+[Pp]ost
+ANSYS
+API
+HDF5
+postprocess
+postprocessing
+(PyDPF\s|PyDPF-Core|PyDPF-Post)
+Pythonic
+R1
+R2
+subresult
+subresults
+Thermal/electric
+UTF-8
+VTK
diff --git a/docs/styles/Vocab/ANSYS/reject.txt → doc/styles/Vocab/ANSYS/reject.txt b/docs/styles/Vocab/ANSYS/reject.txt → doc/styles/Vocab/ANSYS/reject.txt