Merge pull request #210 from csiro-coasts/dual-plot-example

Add sphinx-gallery

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

continuous-integration/docs.yaml

@@ -3,7 +3,9 @@ channels:
 
 dependencies:
   - geos ~=3.12.2
+  - udunits2 >=2.2.25
   - python =3.14
+  - ffmpeg
   - wheel
   - pip:
     - -r ./requirements-3.14.txt

docs/.gitignore

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

docs/_static/images/animated-plot.mp4

@@ -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
 =========