feat: allowing inheritance + adding docs

.github/workflows/ci_cd.yml

@@ -206,10 +206,10 @@ jobs:
           pip install --upgrade pip
           pip install .[doc]
 
-      - name: "Retrieve pyconverter.xml2py version"
+      - name: "Retrieve PyConverter.XML2Py version"
         run: |
           echo "PYCONVERTER_VERSION=$(python -c 'from pyconverter.xml2py import __version__; print(__version__)')" >> $GITHUB_ENV
-          echo "pyconverter.xml2py version is: $(python -c 'from pyconverter.xml2py import __version__; print(__version__)')"
+          echo "PyConverter.XML2Py version is: $(python -c 'from pyconverter.xml2py import __version__; print(__version__)')"
 
       - name: "Cache docs build directory"
         uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v4.2.3 # zizmor: ignore[cache-poisoning]

_package/doc/source/conf.py

@@ -79,7 +79,7 @@
 numpydoc_xref_param_type = True
 numpydoc_validate = True
 numpydoc_validation_checks = {
-    "GL06",  # Found unknown section
+    # "GL06",  # Found unknown section - commenting due to ``Command Specifications`` section
     "GL07",  # Sections are in the wrong order.
     # "GL08",  # The object does not have a docstring
     "GL09",  # Deprecation warning should precede extended summary

config.yaml

@@ -79,4 +79,14 @@ comments:
 
 specific_classes:
   2D to 3D Analysis: Analysis 2D to 3D
-  Parameters: Parameter definition
+  Parameters: Parameter definition
+
+base_class:
+  # Pattern-based inheritance rules
+  # Patterns are matched against "module_name/class_name"
+  # Use "*" for wildcards, e.g., "apdl/*" matches all classes in apdl module
+  # Rules are evaluated in order - first match wins
+  rules:
+    - pattern: "*"
+      module: "ansys.mapdl.core._commands"
+      class_name: "CommandsBase"