fix: command issues (#374)

Author: clatapie

.github/workflows/autodoc_cicd.yml

@@ -16,6 +16,7 @@ env:
   RESET_PIP_CACHE_2: 1
   RESET_AUTOSUMMARY_CACHE_2: 1
   RESET_DOC_BUILD_CACHE_2: 1
+  MAIN_PYTHON_VERSION: '3.12'
 
 
 jobs:
@@ -29,7 +30,7 @@ jobs:
       - name: "Setup Python"
         uses: actions/setup-python@v5
         with:
-          python-version: ${{ inputs.MAIN_PYTHON_VERSION }}
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
       - name: "Cache pip"
         uses: actions/cache@v4
@@ -80,7 +81,7 @@ jobs:
       - name: PyAnsys code style checks
         uses: ansys/actions/code-style@v8
         with:
-          python-version: ${{ inputs.MAIN_PYTHON_VERSION }}
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
           use-python-cache: false
 
 
@@ -98,9 +99,9 @@ jobs:
         uses: actions/cache@v4
         with:
           path: ~/.cache/pip
-          key: Python-pyconverter-generatedcommands-v${{ env.RESET_PIP_CACHE_2 }}-${{ inputs.MAIN_PYTHON_VERSION }}-${{ hashFiles('pyproject.toml') }}
+          key: Python-pyconverter-generatedcommands-v${{ env.RESET_PIP_CACHE_2 }}-${{ env.MAIN_PYTHON_VERSION }}-${{ hashFiles('pyproject.toml') }}
           restore-keys: |
-            Python-pyconverter-generatedcommands-v${{ env.RESET_PIP_CACHE_2 }}-${{ inputs.MAIN_PYTHON_VERSION }}
+            Python-pyconverter-generatedcommands-v${{ env.RESET_PIP_CACHE_2 }}-${{ env.MAIN_PYTHON_VERSION }}
       
       - name: "Install pyconverter-generatedcommands"
         run: |
@@ -130,7 +131,7 @@ jobs:
       - name: "Run Ansys documentation building action"
         uses: ansys/actions/doc-build@v8
         with:
-          python-version: ${{ inputs.MAIN_PYTHON_VERSION }}
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
           checkout: false
           sphinxopts: -j auto
           check-links: false

.github/workflows/ci_cd.yml

@@ -48,7 +48,8 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
-  smoke-tests:
+
+  smoke-tests: # Needs to be re-enabled prior to release
     name: Build and Smoke tests (Linux)
     runs-on: ubuntu-latest
     needs: [code-style]
@@ -59,10 +60,9 @@ jobs:
 
     steps:
       - name: Build wheelhouse and perform smoke test
-        uses: ansys/actions/build-wheelhouse@v8
+        uses: ansys/actions/build-wheelhouse@v10
         with:
           library-name: ${{ env.PACKAGE_NAME }}
-          library-namespace: ${{ env.PACKAGE_NAMESPACE }}
           operating-system: ${{ runner.os }}
           python-version: ${{ matrix.python-version }}
 
@@ -83,15 +83,14 @@ jobs:
         uses: ansys/actions/build-wheelhouse@v8
         with:
           library-name: ${{ env.PACKAGE_NAME }}
-          library-namespace: ${{ env.PACKAGE_NAMESPACE }}
           operating-system: ${{ matrix.os }}
           python-version: ${{ matrix.python-version }}
 
 
   build-test:
     name: "Build and unit testing"
     runs-on: ubuntu-latest
-    needs: [smoke-tests]
+    # needs: [smoke-tests]
 
     steps:
       - name: "Install Git and checkout project"

.gitignore

@@ -165,3 +165,4 @@ cython_debug/
 helper/
 package/
 _autosummary/
+args.txt

.pre-commit-config.yaml

@@ -34,9 +34,11 @@ repos:
   - id: debug-statements
 
 - repo: https://github.com/ansys/pre-commit-hooks
-  rev: v0.2.8 # `strings.properties` needs to be manually updated
+  rev: v0.5.1
   hooks:
-    - id: add-license-headers
+  - id: add-license-headers
+    args:
+    - --start_year=2023
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 ANSYS, Inc. All rights reserved.
+Copyright (c) 2023 - 2025 ANSYS, Inc. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

_package/.pre-commit-config.yaml

@@ -49,12 +49,12 @@ repos:
   hooks:
   - id: flake8
 
-- repo: https://github.com/codespell-project/codespell
-  rev: v2.3.0
-  hooks:
-  - id: codespell
-    args: ["--toml", "pyproject.toml"]
-    additional_dependencies: ["tomli"]
+# - repo: https://github.com/codespell-project/codespell
+#   rev: v2.3.0
+#   hooks:
+#   - id: codespell
+#     args: ["--toml", "pyproject.toml"]
+#     additional_dependencies: ["tomli"]
 
 # - repo: https://github.com/pycqa/pydocstyle
 #   rev: 6.1.1

_package/doc/Makefile

@@ -25,4 +25,4 @@ clean:
 pdf:
 	@$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	cd $(BUILDDIR)/latex && latexmk -r latexmkrc -pdf *.tex -interaction=nonstopmode || true
-	(test -f $(BUILDDIR)/latex/pyconverter-generatedcommands-Documentation-*.pdf && echo pdf exists) || exit 1
+	(test -f $(BUILDDIR)/latex/pyconverter-generatedcommands-documentation-*.pdf && echo pdf exists) || exit 1

_package/doc/make.bat

@@ -57,5 +57,16 @@ goto end
 :help
 %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 
+:pdf
+%SPHINXBUILD% -M latex %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+cd "%BUILDDIR%\latex"
+for %%f in (*.tex) do (
+pdflatex "%%f" --interaction=nonstopmode)
+if NOT EXIST pyconverter-generatedcommands-documentation.pdf (
+	Echo "no pdf generated!"
+	exit /b 1)
+Echo "pdf generated!"
+goto end
+
 :end
 popd

_package/doc/source/conf.py

@@ -65,6 +65,10 @@
     #     "grpc": ("https://grpc.github.io/grpc/python/", None),
 }
 
+suppress_warnings = [
+    "misc.highlighting_failure",  # Suppress highlighting failures
+]
+
 # Copy button customization ---------------------------------------------------
 # exclude traditional Python prompts from the copied code
 copybutton_prompt_text = r">>> ?|\.\.\. "
@@ -77,7 +81,7 @@
 numpydoc_validation_checks = {
     "GL06",  # Found unknown section
     "GL07",  # Sections are in the wrong order.
-    "GL08",  # The object does not have a docstring
+    # "GL08",  # The object does not have a docstring
     "GL09",  # Deprecation warning should precede extended summary
     "GL10",  # reST directives {directives} must be followed by two colons
     "SS01",  # No summary found
@@ -98,7 +102,7 @@
 latex_documents = [
     (
         master_doc,
-        f"{project}-Documentation-{__version__}.tex",
+        f"{project}-documentation-{__version__}.tex",
         f"{project} Documentation",
         author,
         "manual",

config.yaml

@@ -1,13 +1,17 @@
+project_name: PyConverter-GeneratedCommands # Name of the project
+
 library_name_structured: # Future name of the library
   - pyconverter
   - generatedcommands
 
-subfolder:
+subfolders:
   - subfolder
   - subsubfolder
 
 new_package_name: package
 
+image_folder_path: ../images/_commands
+
 rules:
   "/": slash
   "*": star
@@ -18,21 +22,60 @@ specific_command_mapping:
   "/INQUIRE": inquire
 
 ignored_commands:
-  - "*VWR"
-  - "*MWR"
-  - "C***"
-  - "*CFO"
-  - "*CRE"
-  - "*END"
-  - "/EOF"
+  # Non-available commands - PyMAPDL user guide
   - "*ASK"
-  - "*IF"
+  - "*VEDIT"
+  - "/ERASE"
+  - "ERASE"
+  - "HELP"
+  - "HELPDISP"
+  - "NOERASE"
+  - "*CYCLE"
+  - "*DO"
+  - "*DOWHILE"
   - "*ELSE"
-  - "CMAT"
-  - "*REP"
+  - "*ELSEIF"
+  - "*ENDDO"
+  - "*ENDIF"
+  - "*GO"
+  - "*IF"
+  - "*REPEAT"
   - "*RETURN"
-  - "LSRE"
+  - "*DEL"
+  - "/BATCH"
+  - "/EOF"
+  - "UNDO"
+  # Additional commands to ignore
+  - "C***"
+  - "/DIRECTORY" # Defined in ``mapdl_core.py``
+  - "*XPL" # Defined in ``mapdl_grpc.py``
+  - "PLOT"
+  - "/EXIT" # Defined in ``mapdl_core.py``
+
+comments:
+  - msg: 'This command must be run using :func:`non_interactive <ansys.mapdl.core.Mapdl.non_interactive>`.
+
+          Please visit `Unsupported Interactive Commands <https://mapdl.docs.pyansys.com/version/stable/user_guide/mapdl.html#unsupported-interactive-commands>`_
+    
+          for further information.'
+    type: "warning"
+    commands:
+      - "*CREATE"
+      - "CFOPEN"
+      - "CFCLOSE"
+      - "*VWRITE"
+      - "*MWRITE"
+      - "LSWRITE"
+      - "LSREAD"
 
+  - msg: 'Starting with PyMAPDL v0.66.0, you can use "P" as a second argument to select entities interactively. A window pops up
+          
+          allowing you to select, unselect, add or reselect entities depending on the first argument ``type_``. An array with
+          
+          the ids of new selection is returned when the window is closed.'
+    type: "note"
+    commands:
+     - "ASEL"
 
 specific_classes:
   2D to 3D Analysis: Analysis 2D to 3D