Merge branch 'main' into release/0.4

Author: RobPasMue

.github/workflows/ci_cd.yml

@@ -37,10 +37,9 @@ jobs:
             os: macos-latest
     steps:
       - name: "Build wheelhouse and perform smoke test"
-        uses: ansys/actions/build-wheelhouse@v4
+        uses: ansys/actions/build-wheelhouse@v5
         with:
           library-name: ${{ env.PACKAGE_NAME }}
-          library-namespace: ${{ env.PACKAGE_NAMESPACE }}
           operating-system: ${{ matrix.os }}
           python-version: ${{ matrix.python-version }}
 
@@ -61,7 +60,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Setup Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
@@ -82,7 +81,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Ansys documentation style checks
-        uses: ansys/actions/doc-style@v4
+        uses: ansys/actions/doc-style@v5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -92,7 +91,7 @@ jobs:
     needs: [docs-style]
     steps:
       - name: "Run Ansys documentation building action"
-        uses: ansys/actions/doc-build@v4
+        uses: ansys/actions/doc-build@v5
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           dependencies: "build-essential zip pandoc texlive-latex-extra latexmk texlive-pstricks"
@@ -103,7 +102,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Build library source and wheel artifacts
-        uses: ansys/actions/build-library@v4
+        uses: ansys/actions/build-library@v5
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
@@ -115,14 +114,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Release to the public PyPI repository
-        uses: ansys/actions/release-pypi-public@v4
+        uses: ansys/actions/release-pypi-public@v5
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           twine-username: "__token__"
           twine-token: ${{ secrets.PYPI_TOKEN }}
 
       - name: Release to GitHub
-        uses: ansys/actions/release-github@v4
+        uses: ansys/actions/release-github@v5
         with:
           library-name: ${{ env.PACKAGE_NAME }}
 
@@ -133,7 +132,7 @@ jobs:
     needs: [package]
     steps:
       - name: Deploy the latest documentation
-        uses: ansys/actions/doc-deploy-dev@v4
+        uses: ansys/actions/doc-deploy-dev@v5
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
@@ -145,8 +144,7 @@ jobs:
     needs: [release]
     steps:
       - name: Deploy the stable documentation
-        uses: ansys/actions/doc-deploy-stable@v4
+        uses: ansys/actions/doc-deploy-stable@v5
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
-          python-version: ${{ env.MAIN_PYTHON_VERSION }}

.pre-commit-config.yaml

@@ -1,14 +1,14 @@
 repos:
 - repo: https://github.com/psf/black
-  rev: 23.11.0 # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
+  rev: 23.12.1 # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
   hooks:
   - id: black
 
 - repo: https://github.com/adamchainz/blacken-docs
   rev: 1.16.0
   hooks:
   - id: blacken-docs
-    additional_dependencies: [black==23.11.0]
+    additional_dependencies: [black==23.12.1]
 
 - repo: https://github.com/PyCQA/flake8
   rev: 6.1.0
@@ -22,7 +22,7 @@ repos:
     additional_dependencies: ["tomli"]
 
 - repo: https://github.com/pycqa/isort
-  rev: 5.12.0
+  rev: 5.13.2
   hooks:
   - id: isort
 
@@ -36,7 +36,7 @@ repos:
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.27.1
+  rev: 0.27.3
   hooks:
     - id: check-github-workflows
 

pyproject.toml

@@ -9,13 +9,9 @@ version = "0.4.0"
 description = "Library to locate Ansys products in a local machine."
 readme = "README.rst"
 requires-python = ">=3.8,<4"
-license = {file = "LICENSE"}
-authors = [
-    {name = "ANSYS, Inc.", email = "[email protected]"},
-]
-maintainers = [
-    {name = "ANSYS, Inc.", email = "[email protected]"},
-]
+license = { file = "LICENSE" }
+authors = [{ name = "ANSYS, Inc.", email = "[email protected]" }]
+maintainers = [{ name = "ANSYS, Inc.", email = "[email protected]" }]
 
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -28,28 +24,21 @@ classifiers = [
 ]
 dependencies = [
     "platformdirs>=3.6.0",
-    "click>=8.1.3", # for CLI interface
+    "click>=8.1.3",        # for CLI interface
 ]
 
 
 [project.optional-dependencies]
-tests = [
-    "pytest==7.4.3",
-    "pytest-cov==4.1.0",
-    "pyfakefs==5.3.0",
-]
+tests = ["pytest==7.4.4", "pytest-cov==4.1.0", "pyfakefs==5.3.2"]
 
 doc = [
     "Sphinx==7.2.6",
     "numpydoc==1.6.0",
-    "ansys-sphinx-theme==0.12.5",
+    "ansys-sphinx-theme==0.13.0",
     "sphinx-copybutton==0.5.2",
 ]
 
-build = [
-    "build==1.0.3",
-    "twine==4.0.2",
-]
+build = ["build==1.0.3", "twine==4.0.2"]
 
 [tool.flit.module]
 name = "ansys.tools.path"
@@ -74,7 +63,7 @@ line_length = 100
 default_section = "THIRDPARTY"
 src_paths = ["doc", "src", "tests"]
 
-[tools.flake8]
+[tool.flake8]
 max-line-length = 100
 
 [tool.coverage.run]
@@ -84,7 +73,4 @@ source = ["ansys.tools"]
 show_missing = true
 
 [tool.pytest.ini_options]
-markers = [
-    "win32: Mark a test windows only",
-    "linux: Mark a test linux only"
-]
+markers = ["win32: Mark a test windows only", "linux: Mark a test linux only"]

src/ansys/tools/path/path.py

@@ -287,14 +287,14 @@ def find_mechanical(
     --------
     On Windows:
 
-    >>> from ansys.mechanical.core.mechanical import find_mechanical
+    >>> from ansys.tools.path import find_mechanical
     >>> find_mechanical()
-    'C:/Program Files/ANSYS Inc/v231/aisol/bin/winx64/AnsysWBU.exe', 23.1
+    ('C:/Program Files/ANSYS Inc/v231/aisol/bin/winx64/AnsysWBU.exe', 23.1)
 
     On Linux:
 
     >>> find_mechanical()
-    (/usr/ansys_inc/v231/aisol/.workbench, 23.1)
+    ('/usr/ansys_inc/v231/aisol/.workbench', 23.1)
     """
     ans_path, version = _get_unified_install_base_for_version(version, supported_versions)
     if not ans_path or not version: