docs: Fix import issues in doc build. (#2876)

* docs: Fix import issues in doc build. * Update doc. * Update .github/workflows/ci.yml * resolve meta doc error --------- Co-authored-by: Harshal Pohekar <[email protected]> Co-authored-by: Harshal Pohekar <[email protected]>
ansys · Jun 20, 2024 · 776d69d · 776d69d
1 parent 973f9ab
commit 776d69d
Show file tree

Hide file tree

Showing 7 changed files with 4 additions and 19 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -188,6 +188,7 @@ jobs:
             rm poetry.lock
           fi
           poetry install --with docs
+          poetry install -E reader
           make build-doc-source
         env:
           FLUENT_IMAGE_TAG: ${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}

diff --git a/doc/source/api/general/index.rst b/doc/source/api/general/index.rst
@@ -110,5 +110,4 @@ Logging
     execution_utils
     search
     schemeeval
-    meta
     logging
diff --git a/doc/source/api/general/post_objects/index.rst b/doc/source/api/general/post_objects/index.rst
@@ -16,3 +16,4 @@ Post objects
 
     post_helper
     post_objects_container
+    meta
diff --git a/doc/source/api/general/meta.rst → doc/source/api/general/post_objects/meta.rst b/doc/source/api/general/meta.rst → doc/source/api/general/post_objects/meta.rst
@@ -3,9 +3,8 @@
 Meta
 ====
 
-.. automodule:: ansys.fluent.core.meta
+.. automodule:: ansys.fluent.core.post_objects.meta
    :members:
    :show-inheritance:
-   :undoc-members:
    :exclude-members: __weakref__, __dict__
    :autosummary:
diff --git a/doc/source/api/general/services/error_handler.rst b/doc/source/api/general/services/error_handler.rst
diff --git a/doc/source/api/general/services/index.rst b/doc/source/api/general/services/index.rst
@@ -6,8 +6,6 @@ Services
 ==============================  ====================================================================================
 :ref:`ref_batch_ops`            | Executes operations in batch in Fluent.
 
-:ref:`ref_error_handler`        Handles gRPC service errors.
-
 :ref:`ref_events_code`          Begins and ends event streaming service of Fluent.
 
 :ref:`ref_field_data_code`      Extracts Fluent field data and provides access to Fluent field information.
@@ -32,7 +30,6 @@ Services
     :hidden:
 
     batch_ops
-    error_handler
     events
     field_data
     health_check

diff --git a/doc/source/api/meshing/index.rst b/doc/source/api/meshing/index.rst
@@ -104,7 +104,7 @@ TUI commands example
 
     import ansys.fluent.core as pyfluent
 
-    meshing_session = pyfluent.launch_fluent(mode="meshing")
+    meshing_session = pyfluent.launch_fluent(mode=pyfluent.FluentMode.MESHING)
     meshing_session.tui.file.read_case("elbow.cas.gz")
     solver = meshing_session.switch_to_solver()
     solver.tui.define.models.unsteady_2nd_order("yes")
-Original file line number
+Diff line change
@@ Expand Up / @@ -110,5 +110,4 @@ Logging @@
         execution_utils
         search
         schemeeval
-        meta
         logging
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,3 +16,4 @@ Post objects

		post_helper
		post_objects_container
		meta