fix: Default trame visualization in Jupyter environments (#904)

Co-authored-by: Roberto Pastor Muela <[email protected]>

Author: AlejandroFernandezLuces

doc/source/conf.py

@@ -19,6 +19,8 @@
 
 from ansys.geometry.core import __version__
 
+os.environ["PYANSYS_GEOMETRY_DOC_BUILD"] = "true"
+
 LaTeXBuilder.supported_image_types = ["image/png", "image/pdf", "image/svg+xml"]
 
 

pyproject.toml

@@ -80,7 +80,7 @@ doc = [
     "notebook==7.0.6",
     "numpydoc==1.6.0",
     "panel==1.3.6",
-    "pyvista[trame]==0.43.1",
+    "pyvista[jupyter]==0.43.1",
     "requests==2.31.0",
     "sphinx==7.2.5",
     "sphinx-autoapi==3.0.0",            # "sphinx-autoapi @ git+https://github.com/jorgepiloto/sphinx-autoapi@feat/single-page-option", ---> Installed directly in workflow

src/ansys/geometry/core/__init__.py

@@ -32,6 +32,8 @@
 # Ease import statements
 # ------------------------------------------------------------------------------
 
+import os
+
 from ansys.geometry.core.connection.launcher import (
     launch_local_modeler,
     launch_modeler,
@@ -60,3 +62,7 @@
 Only set this to false if you are sure you want to disable this check and you will ONLY
 be working with one design.
 """
+
+DOCUMENTATION_BUILD: bool = os.environ.get("PYANSYS_GEOMETRY_DOC_BUILD", "false").lower() == "true"
+"""Global flag to set when building the documentation to use the proper PyVista Jupyter
+backend."""

src/ansys/geometry/core/plotting/plotter.py

@@ -28,6 +28,7 @@
 from pyvista.plotting.plotter import Plotter as PyVistaPlotter
 from pyvista.plotting.tools import create_axes_marker
 
+from ansys.geometry.core import DOCUMENTATION_BUILD
 from ansys.geometry.core.designer.body import Body, MasterBody
 from ansys.geometry.core.designer.component import Component
 from ansys.geometry.core.designer.design import Design
@@ -547,7 +548,10 @@ def show(
         # Conditionally set the Jupyter backend as not all users will be within
         # a notebook environment to avoid a pyvista warning
         if self.scene.notebook and jupyter_backend is None:
-            # TODO revert this once the dynamic plotters in documentation are back.
+            jupyter_backend = "trame"
+
+        # Override jupyter backend in case we are building docs
+        if DOCUMENTATION_BUILD:
             jupyter_backend = "static"
 
         # Enabling anti-aliasing by default on scene

src/ansys/geometry/core/tools/repair_tools.py

@@ -78,7 +78,7 @@ def find_split_edges(
             The maximum length of the edges.
 
         Returns
-        ----------
+        -------
         List[SplitEdgeProblemAreas]
             List of objects representing split edge problem areas.
         """
@@ -111,7 +111,7 @@ def find_extra_edges(self, bodies: List["Body"]) -> List[ExtraEdgeProblemAreas]:
             List of bodies that extra edges are investigated on.
 
         Returns
-        ----------
+        -------
         List[ExtraEdgeProblemArea]
             List of objects representing extra edge problem areas.
         """