Merge branch 'master' into mhanmer/operator_doc_template

Author: ansMHanmer

.gitignore

@@ -196,3 +196,8 @@ src/ansys/grpc/
 
 # C extensions
 *.so
+
+# Ignore auto-generated API reference
+doc/source/api
+doc/source/examples
+doc/source/images/auto-generated

doc/source/_static/dpf_operators.html

@@ -1,13 +1,18 @@
-import os
-import sys
-from glob import glob
 from datetime import datetime
+from glob import glob
+import os
 
+from ansys_sphinx_theme import (
+    ansys_favicon,
+    get_version_match,
+    pyansys_logo_dark_mode,
+    pyansys_logo_light_mode,
+)
 import numpy as np
 import pyvista
+
 from ansys.dpf.core import __version__, server, server_factory
 from ansys.dpf.core.examples import get_example_required_minimum_dpf_version
-from ansys_sphinx_theme import ansys_favicon, get_version_match, pyansys_logo_light_mode, pyansys_logo_dark_mode
 
 # Manage errors
 pyvista.set_error_output_file("errors.txt")
@@ -161,9 +166,11 @@
 
 
 def reset_servers(gallery_conf, fname, when):
+    import gc
+
     import psutil
+
     from ansys.dpf.core import server
-    import gc
 
     gc.collect()
     server.shutdown_all_session_servers()
@@ -174,7 +181,7 @@ def reset_servers(gallery_conf, fname, when):
         try:
             # check whether the process name matches
             if proc_name in proc.name():
-                # proc.kill()
+                proc.kill()
                 nb_procs += 1
         except psutil.NoSuchProcess:
             pass
@@ -259,7 +266,7 @@ def reset_servers(gallery_conf, fname, when):
 
 # Configuration for Sphinx autoapi
 suppress_warnings = [
-    "autoapi.python_import_resolution", # Todo: remove suppression of this warning in the future
+    "autoapi.python_import_resolution", # TODO: remove suppression of this warning in the future #1967
     "design.grid",
     "config.cache",
     "design.fa-build",
@@ -366,4 +373,4 @@ def reset_servers(gallery_conf, fname, when):
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ["search.html"]
+epub_exclude_files = ["search.html"]

doc/source/conf.py

@@ -1,13 +1,12 @@
 ansys-sphinx-theme[autoapi]==1.3.1
 enum-tools[sphinx]==0.12.0
 graphviz==0.20.1
-imageio==2.36.0
+imageio==2.36.1
 imageio-ffmpeg==0.6.0
 nbsphinx==0.9.6
-pypandoc==1.15
 pytest-sphinx==0.6.3
 pyvista==0.44.2
-sphinx==7.4.7
+sphinx==8.1.3
 sphinx-copybutton==0.5.2
 sphinx-gallery==0.19.0
 sphinx-notfound-page==1.1.0

requirements/requirements_docs.txt

@@ -1,4 +1,4 @@
-importlib-metadata==8.5.0
+importlib-metadata==8.6.1
 numpy==2.2.3
 packaging==24.2
 psutil==7.0.0

requirements/requirements_install.txt

@@ -1,7 +1,7 @@
 ansys-platform-instancemanagement==1.1.2
-coverage==7.6.11
+coverage==7.6.12
 graphviz==0.20.1
-imageio==2.36.0
+imageio==2.36.1
 imageio-ffmpeg==0.6.0
 pytest==8.3.4
 pytest-cov==6.0.0

requirements/requirements_test.txt

@@ -460,6 +460,7 @@ def config_specification(self) -> ConfigSpecification:
         """
         if self._config_specification is None:
             self._config_specification = ConfigSpecification()
+        if self._internal_obj is not None:
             num_options = self._api.operator_specification_get_num_config_options(self)
             for i in range(num_options):
                 option_name = self._api.operator_specification_get_config_name(self, i)

src/ansys/dpf/core/operator_specification.py

@@ -36,7 +36,10 @@ class migrate_to_h5dpf(Operator):
         num_threads: zstd (>0)}
     export_floats : bool, optional
         Converts double to float to reduce file size
-        (default is true)
+        (default is true).if false, nodal
+        results are exported as double
+        precision and elemental results as
+        single precision.
     filename : str
         Filename of the migrated file
     comma_separated_list_of_results : str, optional
@@ -197,7 +200,10 @@ def _spec():
                     type_names=["bool"],
                     optional=True,
                     document="""Converts double to float to reduce file size
-        (default is true)""",
+        (default is true).if false, nodal
+        results are exported as double
+        precision and elemental results as
+        single precision.""",
                 ),
                 0: PinSpecification(
                     name="filename",
@@ -426,7 +432,10 @@ def export_floats(self):
         """Allows to connect export_floats input to the operator.
 
         Converts double to float to reduce file size
-        (default is true)
+        (default is true).if false, nodal
+        results are exported as double
+        precision and elemental results as
+        single precision.
 
         Parameters
         ----------