Examples: Clean up example scripts for building documentation

CSSFrancis · CSSFrancis · commit 5351d95ddc9b · 2024-04-21T09:38:48.000-05:00
diff --git a/doc/conf.py b/doc/conf.py
@@ -46,6 +46,7 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
     "sphinx_design",
+    "sphinx_gallery.gen_gallery",
 ]
 
 # Create links to references within diffsims' documentation to these packages
@@ -162,3 +163,15 @@ def linkcode_resolve(domain, info):
 autodoc_default_options = {
     "show-inheritance": True,
 }
+
+# -- Sphinx-Gallery---------------
+# https://sphinx-gallery.github.io
+sphinx_gallery_conf = {
+    "backreferences_dir": "reference/generated",
+    "doc_module": ("diffsims",),
+    "examples_dirs": "../examples",  # path to your example scripts
+    "gallery_dirs": "examples",  # path to where to save gallery generated output
+    "filename_pattern": "^((?!sgskip).)*$",  # pattern to define which will be executed
+    "ignore_pattern": "_sgskip.py",  # pattern to define which will not be executed
+    "reference_url": {"diffsims": None},
+}
diff --git a/doc/index.rst b/doc/index.rst
@@ -12,6 +12,8 @@ diffsims is an open-source Python library for simulating diffraction.
     reference/index.rst
     dev/index.rst
     changelog.rst
+    Examples <examples/index>
+
 
 Installation
 ============
diff --git a/examples/README.rst b/examples/README.rst
@@ -0,0 +1,6 @@
+.. _examples-index:
+
+Gallery of Examples
+===================
+
+Below is a gallery of examples for different operations in diffsims.
diff --git a/examples/creating_a_simulation_library/README.rst b/examples/creating_a_simulation_library/README.rst
@@ -0,0 +1,6 @@
+.. _examples-index:
+
+Simulation Library
+==================
+
+These examples show specific workflows for creating a library of simulations
diff --git a/examples/creating_a_simulation_library/simulating_diffraction_patterns.py b/examples/creating_a_simulation_library/simulating_diffraction_patterns.py
@@ -1,6 +1,6 @@
 """
 =====================================================
- Simulating One Diffraction Pattern for a Single Phase
+Simulating One Diffraction Pattern for a Single Phase
 =====================================================
 """
 
