add 2 more examples

NCAR · Jul 19, 2023 · 560b946 · 560b946
1 parent 9753c28
commit 560b946
Show file tree

Hide file tree

Showing 7 changed files with 296 additions and 2 deletions.
diff --git a/docs/_static/thumbnails/plot_contour_labels.png b/docs/_static/thumbnails/plot_contour_labels.png
diff --git a/docs/_static/thumbnails/plot_extrema_labels.png b/docs/_static/thumbnails/plot_extrema_labels.png
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -25,3 +25,5 @@ Here are some examples of how to use geocat-viz.
    examples/add_right_hand_axis.ipynb
    examples/add_major_minor_ticks.ipynb
    examples/find_local_extrema.ipynb
+   examples/plot_contour_labels.ipynb
+   examples/plot_extrema_labels.ipynb
diff --git a/docs/examples/plot_contour_labels.ipynb b/docs/examples/plot_contour_labels.ipynb
diff --git a/docs/examples/plot_extrema_labels.ipynb b/docs/examples/plot_extrema_labels.ipynb
diff --git a/docs/gallery.yml b/docs/gallery.yml
@@ -25,3 +25,11 @@
 - title: 'find_local_extrema'
   path: examples/find_local_extrema.ipynb
   thumbnail: _static/thumbnails/find_local_extrema.png
+
+- title: 'plot_contour_labels'
+  path: examples/plot_contour_labels.ipynb
+  thumbnail: _static/thumbnails/plot_contour_labels.png
+
+- title: 'plot_extrema_labels'
+  path: examples/plot_extrema_labels.ipynb
+  thumbnail: _static/thumbnails/plot_extrema_labels.png
diff --git a/src/geocat/viz/util.py b/src/geocat/viz/util.py
@@ -1173,7 +1173,9 @@ def plot_contour_labels(ax: matplotlib.axes.Axes,
 
     Examples
     --------
-    All usage examples are within the GeoCAT-Examples Gallery. To see more usage cases, search the function on the `website <https://geocat-examples.readthedocs.io/en/latest/index.html>`_.
+    See this example notebook: :doc:`../../examples/plot_contour_labels`.
+
+    More in-depth plotting examples that utilize this function are in the GeoCAT-Examples Gallery. To see more usage cases, search the function on the `website <https://geocat-examples.readthedocs.io/en/latest/index.html>`_.
 
     - `NCL_sat_1.py <https://geocat-examples.readthedocs.io/en/latest/gallery/MapProjections/NCL_sat_1.html?highlight=plotCLabels>`_
     """
@@ -1326,7 +1328,9 @@ def plot_extrema_labels(da: xr.DataArray,
 
     Examples
     --------
-    All usage examples are within the GeoCAT-Examples Gallery. To see more usage cases, search the function on the `website <https://geocat-examples.readthedocs.io/en/latest/index.html>`_.
+    See this example notebook: :doc:`../../examples/plot_extrema_labels`.
+
+    More in-depth plotting examples that utilize this function are in the GeoCAT-Examples Gallery. To see more usage cases, search the function on the `website <https://geocat-examples.readthedocs.io/en/latest/index.html>`_.
 
     - `NCL_sat_1.py <https://geocat-examples.readthedocs.io/en/latest/gallery/MapProjections/NCL_sat_1.html?highlight=plotELabels>`_