Fix references to the new sphinx-gallery generated examples

Author: mx-moth

README.md

@@ -49,6 +49,9 @@ geometry.write_shapefile(dataset, './gbr4.shp')
 
 ## Examples
 
+The `examples/` directory contains examples of making many different plots.
+These are included in the documentation under [Examples][emsarray-examples].
+
 Examples of using `emsarray` are available in the [emsarray-notebooks][emsarray-notebooks] repository.
 You can [explore these notebooks online][emsarray-binder] with Binder.
 
@@ -98,6 +101,7 @@ You can the view the docs at <http://localhost:5500>
 [emsarray-binder]: https://mybinder.org/v2/gh/csiro-coasts/emsarray-notebooks/HEAD
 [emsarray-conda-forge]: https://anaconda.org/conda-forge/emsarray/
 [emsarray-documentation]: https://emsarray.readthedocs.io
+[emsarray-examples]: https://emsarray.readthedocs.io/en/stable/examples/
 [emsarray-notebooks]: https://github.com/csiro-coasts/emsarray-notebooks
 [emsarray-pypi]: https://pypi.org/project/emsarray/
 [emsarray-source-code]: https://github.com/csiro-coasts/emsarray

docs/api/plot.rst

@@ -11,11 +11,10 @@ The :func:`plot_on_figure` and :func:`animate_on_figure` functions
 will generate a simple plot of any supported variables.
 These functions are intended as quick and simple ways of exploring a dataset
 and have limited customisation options.
-Consult the :ref:`examples gallery <examples>`
-for demonstrations on making more customised plots.
 
-The :ref:`examples <examples>` section contains many worked examples on how to generate plots.
-:ref:`example-plot-with-clim` is a good place to start.
+The :ref:`examples <examples>` section contains many worked examples
+on how to generate plots with more customisations.
+:ref:`sphx_glr_examples_plot-with-clim.py` is a good place to start.
 
 Shortcuts
 =========

docs/api/transect.rst

@@ -12,13 +12,7 @@ Transects are vertical slices along some path through your dataset.
 Examples
 --------
 
-.. list-table::
-
-   * - :ref:`example-kgari-transect`
-
-       .. image:: /_static/images/kgari-transect.png
-          :width: 200
-          :class: no-scaled-link
+.. minigallery:: ../examples/plot-kgari-transect.py
 
 .. autofunction:: plot
 

docs/releases/0.10.0.rst

@@ -8,7 +8,7 @@ Released on 2025-09-08
   where some variables are lacking a `standard_name` (:issue:`178`, :pr:`180`).
 * Updated the tests to be compatible with the latest xarray versions (:pr:`182`).
 * Added an example to the documentation showing
-  :ref:`how to set the clim parameter in plots <example-plot-with-clim>`
+  :ref:`how to set the clim parameter in plots <sphx_glr_examples_plot-with-clim.py>`
   (:pr:`179`).
 * Bumped pinned dependencies (:pr:`183`).
 * Fixed :func:`emsarray.utils.datetime_from_np_time`

examples/plot-animation.py

@@ -1,6 +1,4 @@
 """
-.. _example-animated-plot:
-
 =============
 Animated plot
 =============

examples/plot-kgari-transect.py

@@ -1,6 +1,4 @@
 """
-.. _example-kgari-transect:
-
 ====================
 K'gari transect plot
 ====================

examples/plot-set-extent.py

@@ -1,6 +1,4 @@
 """
-.. _example-plot-set-extent:
-
 ================================
 Plot a small area with landmarks
 ================================

examples/plot-with-clim.py

@@ -1,6 +1,4 @@
 """
-.. _example-plot-with-clim:
-
 ===============================
 Plot with specified data limits
 ===============================

src/emsarray/conventions/_base.py

@@ -1134,9 +1134,8 @@ def animate_on_figure(
 
         This method is a shortcut for quickly generating simple animations.
         It is not intended to be fully featured.
-        See the :ref:`examples <examples>` for more comprehensive plotting examples.
-
-        For real world examples, refer to the ``examples/animation.ipynb`` notebook.
+        See the :ref:`examples <examples>` for more comprehensive plotting examples,
+        and specifically :ref:`sphx_glr_examples_plot-animation.py` for an animated example.
 
         Parameters
         ----------

src/emsarray/plot/shortcuts.py

@@ -96,7 +96,7 @@ def add_landmarks(
 
     Examples
     --------
-    :ref:`example-plot-set-extent`
+    .. minigallery:: ../examples/plot-set-extent.py
     """
     outline = patheffects.withStroke(
         linewidth=outline_width, foreground=outline_color)