diff --git a/doc/api_rstgen.py b/doc/api_rstgen.py index 92f404f25dd..d96a94afeb2 100644 --- a/doc/api_rstgen.py +++ b/doc/api_rstgen.py @@ -86,6 +86,7 @@ def _get_file_path(folder_name: str, file_name: str): "flunits", "settings_external", "datamodel/index", + "settings_root", "tui/index", ], "streaming_services": [ @@ -156,14 +157,27 @@ def _generate_api_source_rst_files(folder: str, files: list): with open(rst_file, "w", encoding="utf8") as rst: rst.write(f".. _ref_{file}:\n\n") if folder: - rst.write(f"{file}\n") - rst.write(f'{"="*(len(f"{file}"))}\n\n') - rst.write(f".. automodule:: ansys.fluent.core.{folder}.{file}\n") + if "root" in file: + rst.write(f"solver.settings\n") + rst.write(f'{"=" * (len("solver.settings"))}\n\n') + rst.write( + "The :ref:`ref_root` is the top-level solver settings object. It contains all\n" + ) + rst.write( + "other settings objects in a hierarchical structure.\n" + ) + else: + rst.write(f"{file}\n") + rst.write(f'{"=" * (len(f"{file}"))}\n\n') + rst.write( + f".. automodule:: ansys.fluent.core.{folder}.{file}\n" + ) else: rst.write(f"ansys.fluent.core.{file}\n") rst.write(f'{"="*(len(f"ansys.fluent.core.{file}"))}\n\n') rst.write(f".. automodule:: ansys.fluent.core.{file}\n") - _write_common_rst_members(rst_file=rst) + if not "root" in file: + _write_common_rst_members(rst_file=rst) def _generate_api_index_rst_files(): diff --git a/pyproject.toml b/pyproject.toml index a0d82d0685f..c20835fb19f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api" [tool.poetry] # Check https://python-poetry.org/docs/pyproject/ for all available sections name = "ansys-fluent-core" -version = "0.24.1" +version = "0.24.2" description = "PyFluent provides Pythonic access to Ansys Fluent" license = "MIT" authors = ["ANSYS, Inc. "] diff --git a/src/ansys/fluent/core/_version.py b/src/ansys/fluent/core/_version.py index 0c9e7387360..e0cb0a670ab 100644 --- a/src/ansys/fluent/core/_version.py +++ b/src/ansys/fluent/core/_version.py @@ -6,7 +6,7 @@ """ # major, minor, patch -version_info = 0, 24, "1" +version_info = 0, 24, 2 # Nice string for the version __version__ = ".".join(map(str, version_info)) diff --git a/src/ansys/fluent/core/post_objects/post_helper.py b/src/ansys/fluent/core/post_objects/post_helper.py index 520aa420f9b..de54adc3c1b 100644 --- a/src/ansys/fluent/core/post_objects/post_helper.py +++ b/src/ansys/fluent/core/post_objects/post_helper.py @@ -103,11 +103,15 @@ def __init__(self, obj): self.obj = obj self.field_info = lambda: obj.get_root().session.fields.field_info self.field_data = lambda: obj.get_root().session.fields.field_data - self.monitors = obj.get_root().session.monitors self.id = lambda: obj.get_root().session.id if obj.__class__.__name__ == "Surface": self.surface_api = PostAPIHelper._SurfaceAPI(obj) + @property + def monitors(self): + """Returns the session monitors.""" + return self.obj.get_root().session.monitors + def remote_surface_name(self, local_surface_name): """Returns the surface name."""