Adding dynamic plots in documentation

doc/source/conf.py

@@ -6,6 +6,7 @@
 from ansys_sphinx_theme import ansys_favicon, get_version_match, pyansys_logo_black
 import numpy as np
 import pyvista
+from pyvista.plotting.utilities.sphinx_gallery import DynamicScraper
 from sphinx.application import Sphinx
 from sphinx_gallery.sorting import FileNameSortKey
 
@@ -22,6 +23,18 @@
 # must be less than or equal to the XVFB window size
 try:
     pyvista.global_theme.window_size = np.array([1024, 768])
+    # Manage errors
+    pyvista.set_error_output_file("errors.txt")
+    # Ensure that offscreen rendering is used for docs generation
+    pyvista.OFF_SCREEN = True  # Not necessary - simply an insurance policy
+    # Preferred plotting style for documentation
+    pyvista.set_plot_theme("document")
+    pyvista.global_theme.font.size = 22
+    pyvista.global_theme.font.label_size = 22
+    pyvista.global_theme.font.title_size = 22
+    pyvista.global_theme.return_cpos = False
+    pyvista.set_jupyter_backend(None)
+
 except AttributeError:
     # for compatibility with pyvista < 0.40
     pyvista.rcParams["window_size"] = np.array([1024, 768])
@@ -69,6 +82,7 @@
 extensions = [
     "jupyter_sphinx",
     "numpydoc",
+    "pyvista.ext.viewer_directive",
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.coverage",
@@ -237,9 +251,10 @@
     "backreferences_dir": None,
     # Modules for which function level galleries are created.  In
     "doc_module": "ansys-mapdl-core",
-    "image_scrapers": ("pyvista", "matplotlib"),
-    "ignore_pattern": "flycheck*",
-    "thumbnail_size": (350, 350),
+    "image_scrapers": (DynamicScraper(), "matplotlib"),
+    # "ignore_pattern": "flycheck*",
+    # "thumbnail_size": (350, 350),
+    "reset_modules_order": "both",
 }
 # ---
 
@@ -285,6 +300,10 @@
 }
 html_show_sourcelink = False
 
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+html_show_sphinx = False
+
+
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.

pyproject.toml

@@ -89,7 +89,7 @@ doc = [
     "pypandoc==1.11",
     "pytest-sphinx==0.5.0",
     "pythreejs==2.4.2",
-    "pyvista[trame]==0.41.1",
+    "pyvista[jupyter,trame]==0.41.1",
     "sphinx-autobuild==2021.3.14",
     "sphinx-autodoc-typehints==1.24.0",
     "sphinx-copybutton==0.5.2",
@@ -98,6 +98,11 @@ doc = [
     "sphinxemoji==0.2.0",
     "sphinx-reredirects==0.1.2",
     "vtk==9.2.6",
+    "sphinx-toolbox",
+    "sphinxcontrib-asciinema",
+    "sphinxcontrib-websupport",
+    "typed-ast",
+    "pydata-sphinx-theme",
 ]
 
 [tool.flit.module]