Merge pull request #37 from pyiron/docs_notebooks

Add example notebooks to docs
pyiron · Jan 15, 2024 · 9f51a6f · 9f51a6f
2 parents 96afa88 + 0ba5375
commit 9f51a6f
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 2 deletions.
diff --git a/.ci_support/environment-docs.yml b/.ci_support/environment-docs.yml
@@ -2,4 +2,6 @@ channels:
 - conda-forge
 dependencies:
   - myst-parser
-  - sphinxcontrib-mermaid
+  - sphinxcontrib-mermaid
+  - sphinx-gallery
+  - sphinx-rtd-theme
diff --git a/docs/_static/pyiron-logo-dark.png b/docs/_static/pyiron-logo-dark.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -38,6 +38,7 @@
     'sphinxcontrib.mermaid',
     'myst_parser',
     'nbsphinx',
+    'sphinx_gallery.load_style',
     'sphinx.ext.mathjax',
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
@@ -51,6 +52,11 @@
 mermaid_params = ['-p' 'puppeteer-config.json']
 mermaid_output_format = "png"
 
+nbsphinx_thumbnails = {
+    'source/notebooks/example': "_static/pyiron-logo-dark.png",
+    'source/notebooks/pizza': "_static/pyiron-logo-dark.png",
+}
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

diff --git a/docs/environment.yml b/docs/environment.yml
@@ -10,3 +10,5 @@ dependencies:
 - pint =0.23
 - myst-parser
 - sphinxcontrib-mermaid
+- sphinx-gallery
+- sphinx-rtd-theme
diff --git a/docs/index.rst b/docs/index.rst
@@ -9,4 +9,5 @@
 .. toctree::
    :hidden:
 
+   source/examples.rst
    source/indices.rst
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -0,0 +1,11 @@
+.. _examples:
+
+
+Example Notebooks
+=================
+
+.. nbgallery::
+   :maxdepth: 2
+   :glob:
+
+   notebooks/*
diff --git a/docs/source/indices.rst b/docs/source/indices.rst
@@ -9,4 +9,4 @@ API Documentation
 
 
 .. toctree::
-   :maxdepth:2
+   :maxdepth: 2
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,4 +9,4 @@ API Documentation


		.. toctree::
		:maxdepth:2
		:maxdepth: 2