Fix : Documentation of examples

.gitignore

@@ -74,6 +74,7 @@ instance/
 
 # Sphinx documentation
 doc/_build/
+doc/source/examples
 
 # PyBuilder
 .pybuilder/
@@ -161,4 +162,8 @@ PyMAPDL_Dev
 doc/source/technology_showcase_examples/*.ipynb
 doc/source/technology_showcase_examples/*.py
 doc/source/technology_showcase_examples/*.md5
-doc/source/technology_showcase_examples/*.pickle
+doc/source/technology_showcase_examples/*.pickle
+
+# Results generated during doc build and example run locally
+examples/technology_showcase/out
+examples/basic/out

doc/source/conf.py

@@ -2,6 +2,7 @@
 from datetime import datetime
 import os
 
+import ansys.mechanical.core
 from ansys_sphinx_theme import ansys_favicon
 from ansys_sphinx_theme import pyansys_logo_black as logo
 import numpy as np
@@ -59,9 +60,9 @@
     # convert rst to md for ipynb
     "pypandoc": True,
     # path to your examples scripts
-    "examples_dirs": ["../../examples/basic"],
+    "examples_dirs": ["../../examples/"],
     # path where to save gallery generated examples
-    "gallery_dirs": ["basic"],
+    "gallery_dirs": ["examples"],
     # Pattern to search for example files
     "filename_pattern": r"\.py",
     # Remove the "Download all examples" button from the top level gallery
@@ -126,6 +127,9 @@
 if not os.path.exists(pyvista.FIGURE_PATH):
     os.makedirs(pyvista.FIGURE_PATH)
 
+# configure pymechanical for embedding
+ansys.mechanical.core.BUILDING_GALLERY = True
+
 # static path
 html_static_path = ["_static"]
 

doc/source/index.rst

@@ -1,33 +1,20 @@
-.. _sphx_glr_pymechanical_embedding_examples:
-
 PyMechanical Embedding Examples
 ===============================
 
 Embedding examples for `PyMechanical <_pymechanical_docs>`_ are contained in this repository.
 
+.. === EXAMPLES Gallery ===
 
-.. === BASIC EXAMPLES ===
-
-Basic Examples
-==============
-
-
-These demonstrate basic simulation capabilities of Ansys Mechanical.
-The problems demonstrate how to use the embedding feature of PyMechanical to
-effectively and accurately solve interdisciplinary problems from a variety of
-industries and engineering fields.
-
-Summary of the exposed basic examples
---------------------------------------
+..
+   We have to include this rather than include it in a tree.
 
-.. include:: ./basic_examples/index.rst
-  :start-line: 7
-  :end-line: 33
+.. include:: examples/index.rst
+   :start-line: 2
 
-.. === EXAMPLES ===
+.. === Include examples/index to avoid warning but it is not shown ===
 
 .. toctree::
-    :hidden:
-    :includehidden:
+   :hidden:
+   :includehidden:
 
-    basic_examples/index
+   examples/index

examples/README.txt

@@ -0,0 +1,8 @@
+.. _ref_example_gallery:
+
+Examples
+========
+End-to-end examples show how you can use pymechanical.
+
+.. note::
+    Some examples require additional Python packages.