Use sphinx-gallery for making the example plots

Author: mx-moth

docs/.gitignore

@@ -1 +1,2 @@
-_build
+_build/
+examples/

docs/_static/images/animated-plot.mp4

@@ -40,6 +40,7 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.napoleon',
     'sphinxcontrib.video',
+    'sphinx_gallery.gen_gallery',
     'roles'
 ]
 
@@ -65,6 +66,10 @@
 html_static_path = ['_static']
 
 
+def setup(app):
+    app.add_css_file("hide_links.css")
+
+
 # Options for generated documentation
 add_module_names = True
 
@@ -99,3 +104,13 @@
     'shapely': ('https://shapely.readthedocs.io/en/stable/', None),
     'xarray': ('https://docs.xarray.dev/en/stable/', None),
 }
+
+
+# Sphinx gallery configuration
+sphinx_gallery_conf = {
+    'examples_dirs': '../examples',
+    'gallery_dirs': './examples',
+    'filename_pattern': '/plot-',
+    'matplotlib_animations': True,
+    'backreferences_dir': './examples/backreferences',
+}