Resolved doc issues

codegen/datamodelgen.py

@@ -5,7 +5,7 @@
 from typing import Any, Dict
 
 from ansys.api.fluent.v0 import datamodel_se_pb2 as DataModelProtoModule
-from ansys.fluent.core.session import _BaseSession as Session
+from ansys.fluent.core.session import BaseSession as Session
 from ansys.fluent.core.utils.fluent_version import get_version_for_filepath
 
 _THIS_DIR = Path(__file__).parent
@@ -289,7 +289,10 @@ def _write_doc_for_model_object(
         with open(index_file, "w", encoding="utf8") as f:
             ref = "_ref_" + "_".join([x.strip("_") for x in heading.split(".")])
             f.write(f".. {ref}:\n\n")
-            heading_ = heading.replace("_", "\_")
+            if class_name == "Root":
+                heading_ = heading.replace("_", "\_")
+            else:
+                heading_ = class_name.split(".")[-1]
             f.write(f"{heading_}\n")
             f.write(f"{'=' * len(heading_)}\n")
             f.write("\n")

codegen/tuigen.py

@@ -259,7 +259,10 @@ def _write_doc_for_menu(self, menu, doc_dir: Path, heading, class_name) -> None:
         with open(index_file, "w", encoding="utf8") as f:
             ref = "_ref_" + "_".join([x.strip("_") for x in heading.split(".")])
             f.write(f".. {ref}:\n\n")
-            heading_ = heading.replace("_", "\_")
+            if class_name == "main_menu":
+                heading_ = heading.replace("_", "\_")
+            else:
+                heading_ = class_name.split(".")[-1]
             f.write(f"{heading_}\n")
             f.write(f"{'=' * len(heading_)}\n")
             desc = MENU_DESCRIPTIONS.get(heading)

doc/source/api/general/case_reader.rst

@@ -50,3 +50,11 @@ Along with basic functionality, the case reader provides many additional feature
     >>> reader.rp_vars()
     >>> reader.config_vars()
 
+
+.. automodule:: ansys.fluent.core.filereader.case_file
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__
+   :special-members: __init__
+   :autosummary:

doc/source/api/general/data_transfer.rst

@@ -42,3 +42,11 @@ pure meshing session and transfer it to a solver session.
 
 Similarly, you can use the ``transfer_case`` method to transfer a case file from one instance of Fluent
 to another.
+
+.. automodule:: ansys.fluent.core.utils.data_transfer
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__
+   :special-members: __init__
+   :autosummary:

doc/source/api/general/sessions/Meshing/index.rst

@@ -0,0 +1,20 @@
+.. _ref_meshing_sessions:
+
+Meshing sessions
+================
+
+=================================  ===========================================================
+:ref:`ref_session_meshing`         | Module containing class encapsulating Fluent connection.
+
+:ref:`ref_session_base_meshing`    Module containing class encapsulating Fluent connection.
+
+:ref:`ref_session_pure_meshing`    Module containing class encapsulating Fluent connection.
+=================================  ===========================================================
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    session_meshing
+    session_base_meshing
+    session_pure_meshing

doc/source/api/general/sessions/Meshing/session_base_meshing.rst

@@ -0,0 +1,12 @@
+.. _ref_session_base_meshing:
+
+session_base_meshing
+====================
+
+.. automodule:: ansys.fluent.core.session_base_meshing
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__
+   :special-members: __init__
+   :autosummary:

doc/source/api/general/sessions/Meshing/session_meshing.rst

@@ -0,0 +1,12 @@
+.. _ref_session_meshing:
+
+session_meshing
+===============
+
+.. automodule:: ansys.fluent.core.session_meshing
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__
+   :special-members: __init__
+   :autosummary:

doc/source/api/general/sessions/Meshing/session_pure_meshing.rst

@@ -0,0 +1,12 @@
+.. _ref_session_pure_meshing:
+
+session_pure_meshing
+====================
+
+.. automodule:: ansys.fluent.core.session_pure_meshing
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__
+   :special-members: __init__
+   :autosummary:

doc/source/api/general/sessions/Session/fluent_connection.rst

@@ -0,0 +1,12 @@
+.. _ref_fluent_connection:
+
+fluent_connection
+=================
+
+.. automodule:: ansys.fluent.core.fluent_connection
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__
+   :special-members: __init__
+   :autosummary:

doc/source/api/general/sessions/Session/index.rst

@@ -0,0 +1,17 @@
+.. _ref_Session:
+
+Session
+=======
+
+==============================  ===============================================================================
+:ref:`ref_session`              | Module containing class encapsulating Fluent connection and the Base Session.
+
+:ref:`ref_fluent_connection`    Encapsulates a Fluent connection.
+==============================  ===============================================================================
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    session
+    fluent_connection

doc/source/api/general/sessions/Session/session.rst

@@ -0,0 +1,12 @@
+.. _ref_session:
+
+session
+=======
+
+.. automodule:: ansys.fluent.core.session
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__
+   :special-members: __init__
+   :autosummary:

doc/source/api/general/sessions/Solver/index.rst

@@ -0,0 +1,20 @@
+.. _ref_solver_sessions:
+
+Solver sessions
+===============
+
+=================================  ===========================================================
+:ref:`ref_session_solver`          | Module containing class encapsulating Fluent connection.
+
+:ref:`ref_session_solver_icing`    Module containing class encapsulating Fluent connection.
+
+:ref:`ref_session_solver_lite`     Module containing class encapsulating Fluent connection.
+=================================  ===========================================================
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    session_solver
+    session_solver_icing
+    session_solver_lite

doc/source/api/general/sessions/Solver/session_solver.rst

@@ -0,0 +1,12 @@
+.. _ref_session_solver:
+
+session_solver
+==============
+
+.. automodule:: ansys.fluent.core.session_solver
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__
+   :special-members: __init__
+   :autosummary:

doc/source/api/general/sessions/Solver/session_solver_icing.rst

@@ -0,0 +1,12 @@
+.. _ref_session_solver_icing:
+
+session_solver_icing
+====================
+
+.. automodule:: ansys.fluent.core.session_solver_icing
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__
+   :special-members: __init__
+   :autosummary:

doc/source/api/general/sessions/Solver/session_solver_lite.rst

@@ -0,0 +1,12 @@
+.. _ref_session_solver_lite:
+
+session_solver_lite
+===================
+
+.. automodule:: ansys.fluent.core.session_solver_lite
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__
+   :special-members: __init__
+   :autosummary:

doc/source/api/general/sessions/index.rst

@@ -3,47 +3,42 @@
 Sessions
 ========
 
-
 Session
 -------
 
-.. currentmodule:: ansys.fluent.core
-
-.. autosummary::
-    :toctree: _autosummary
-    :template: flobject-module-template.rst
-    :recursive:
-
-    session
-    fluent_connection
+==============================  ===============================================================================
+:ref:`ref_session`              | Module containing class encapsulating Fluent connection and the Base Session.
 
+:ref:`ref_fluent_connection`    Encapsulates a Fluent connection.
+==============================  ===============================================================================
 
 Meshing sessions
 ----------------
 
-.. currentmodule:: ansys.fluent.core
+=================================  ===========================================================
+:ref:`ref_session_meshing`         | Module containing class encapsulating Fluent connection.
 
-.. autosummary::
-    :toctree: _autosummary
-    :template: flobject-module-template.rst
-    :recursive:
-
-    session_meshing
-    session_base_meshing
-    session_pure_meshing
+:ref:`ref_session_base_meshing`    Module containing class encapsulating Fluent connection.
 
+:ref:`ref_session_pure_meshing`    Module containing class encapsulating Fluent connection.
+=================================  ===========================================================
 
 Solver sessions
 ---------------
 
-.. currentmodule:: ansys.fluent.core
+=================================  ===========================================================
+:ref:`ref_session_solver`          | Module containing class encapsulating Fluent connection.
+
+:ref:`ref_session_solver_icing`    Module containing class encapsulating Fluent connection.
+
+:ref:`ref_session_solver_lite`     Module containing class encapsulating Fluent connection.
+=================================  ===========================================================
 
-.. autosummary::
-    :toctree: _autosummary
-    :template: flobject-module-template.rst
-    :recursive:
 
-    session_solver
-    session_solver_icing
-    session_solver_lite
+.. toctree::
+    :maxdepth: 1
+    :hidden:
 
+    Session/index
+    Meshing/index
+    Solver/index

doc/source/api/general/utils/index.rst

@@ -3,11 +3,10 @@
 Asynchronous execution
 ======================
 
-.. currentmodule:: ansys.fluent.core.utils
-
-.. autosummary::
-    :toctree: _autosummary
-    :template: flobject-module-template.rst
-    :recursive:
-
-    async_execution
+.. automodule:: ansys.fluent.core.utils.async_execution
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__
+   :special-members: __init__
+   :autosummary:

doc/styles/Vocab/ANSYS/accept.txt

@@ -8,6 +8,7 @@ endfor
 endif
 Fluent
 fluent
+fluent_connection
 Fluent's
 fullname
 hexahedral
@@ -33,6 +34,14 @@ Pythonic
 pyvista
 rpvars
 sbatch
+session
+session_meshing
+session_base_meshing
+session_pure_meshing
+session_solver
+session_solver_icing
+session_solver_lite
+Session
 Slurm
 UDFs
 Univa

src/ansys/fluent/core/__init__.py

@@ -14,7 +14,7 @@
     launch_fluent,
 )
 from ansys.fluent.core.services.batch_ops import BatchOps  # noqa: F401
-from ansys.fluent.core.session import _BaseSession as Fluent  # noqa: F401
+from ansys.fluent.core.session import BaseSession as Fluent  # noqa: F401
 from ansys.fluent.core.utils import fldoc
 from ansys.fluent.core.utils.setup_for_fluent import setup_for_fluent  # noqa: F401
 

src/ansys/fluent/core/filereader/case_file.py

@@ -3,16 +3,13 @@
 Example
 -------
 
-from ansys.fluent.core.filereader.case import Case
+.. code-block:: python
 
-Instantiate a case reader
+    from ansys.fluent.core.filereader.case import Case
+    reader = Case(case_filepath=case_filepath)      # Instantiate a case reader
+    input_parameters = reader.input_parameters()    # Get lists of input parameters
+    output_parameters = reader.output_parameters()  # Get lists of output parameters
 
-reader = Case(case_filepath=case_filepath)
-
-Get lists of input and output parameters
-
-input_parameters = reader.input_parameters()
-output_parameters = reader.output_parameters()
 """
 import codecs
 import gzip