From 776d69d737ed5f378a1d93399a51a0577ff5120d Mon Sep 17 00:00:00 2001 From: Prithwish Mukherjee <109645853+prmukherj@users.noreply.github.com> Date: Thu, 20 Jun 2024 16:38:48 +0530 Subject: [PATCH] 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 <106588300+hpohekar@users.noreply.github.com> Co-authored-by: Harshal Pohekar --- .github/workflows/ci.yml | 1 + doc/source/api/general/index.rst | 1 - doc/source/api/general/post_objects/index.rst | 1 + doc/source/api/general/{ => post_objects}/meta.rst | 3 +-- doc/source/api/general/services/error_handler.rst | 12 ------------ doc/source/api/general/services/index.rst | 3 --- doc/source/api/meshing/index.rst | 2 +- 7 files changed, 4 insertions(+), 19 deletions(-) rename doc/source/api/general/{ => post_objects}/meta.rst (67%) delete mode 100644 doc/source/api/general/services/error_handler.rst diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 39cdebd5ecd..3b4f2258c5e 100644 --- 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 index 60a4394b38f..153abc27c04 100644 --- 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 index 6c0a2fddb95..e23cc13d0e9 100644 --- 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 b/doc/source/api/general/post_objects/meta.rst similarity index 67% rename from doc/source/api/general/meta.rst rename to doc/source/api/general/post_objects/meta.rst index 89d52ea9a81..5a59bd24ec4 100644 --- a/doc/source/api/general/meta.rst +++ b/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 deleted file mode 100644 index 6b49ab08c3b..00000000000 --- a/doc/source/api/general/services/error_handler.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _ref_error_handler: - -error_handler -============= - -.. automodule:: ansys.fluent.core.services.error_handler - :members: - :show-inheritance: - :undoc-members: - :exclude-members: __weakref__, __dict__ - :special-members: __init__ - :autosummary: diff --git a/doc/source/api/general/services/index.rst b/doc/source/api/general/services/index.rst index c1a3db41691..c2d1b4b2743 100644 --- 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 index a4672a3e3fd..4eeda4f91ed 100644 --- 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")