add examples cross-references (#1304)

* add examples cross-references * add changelog news fragment
bjlittle · Jan 30, 2025 · e0009c3 · e0009c3
1 parent 9774ce0
commit e0009c3
Show file tree

Hide file tree

Showing 13 changed files with 23 additions and 3 deletions.
diff --git a/changelog/1304.contributor.rst b/changelog/1304.contributor.rst
@@ -0,0 +1,2 @@
+Added ``sphinx`` cross-references to the :ref:`gv-examples`.
+(:user:`bjlittle`)
diff --git a/docs/src/installation.rst b/docs/src/installation.rst
@@ -26,7 +26,7 @@ and `PyPI`_, and can be easily installed:
             pip install geovista
 
 Additional package dependencies will be required by some of the
-``geovista`` :ref:`Gallery Examples <gv-examples-gallery>`.
+``geovista`` :ref:`Gallery Examples <gv-examples>`.
 
 These packages may be installed with:
 

diff --git a/docs/src/next_steps.rst b/docs/src/next_steps.rst
@@ -116,7 +116,7 @@ similar gallery examples organised by specific features:
     .. grid-item-card:: Examples
         :class-title: custom-title
         :class-body: custom-body
-        :link: gv-examples-gallery
+        :link: gv-examples
         :link-type: ref
         :img-top: _static/images/icons/examples.svg
         :class-img-top: dark-light

diff --git a/src/geovista/examples/README.rst b/src/geovista/examples/README.rst
@@ -1,4 +1,4 @@
-.. _gv-examples-gallery:
+.. _gv-examples:
 
 *********************
 :fa:`images` Examples

diff --git a/src/geovista/examples/curvilinear/README.rst b/src/geovista/examples/curvilinear/README.rst
@@ -1,2 +1,4 @@
+.. _gv-examples-curvilinear:
+
 Curvilinear Grid
 ================
diff --git a/src/geovista/examples/extraction/README.rst b/src/geovista/examples/extraction/README.rst
@@ -1,2 +1,4 @@
+.. _gv-examples-extraction:
+
 Region Extraction
 =================
diff --git a/src/geovista/examples/point_cloud/README.rst b/src/geovista/examples/point_cloud/README.rst
@@ -1,2 +1,4 @@
+.. _gv-examples-point-cloud:
+
 Point Cloud
 ===========
diff --git a/src/geovista/examples/rectilinear/README.rst b/src/geovista/examples/rectilinear/README.rst
@@ -1,2 +1,4 @@
+.. _gv-examples-rectilinear:
+
 Rectilinear Grid
 ================
diff --git a/src/geovista/examples/scalar_data/README.rst b/src/geovista/examples/scalar_data/README.rst
@@ -1,2 +1,4 @@
+.. _gv-examples-scalar-data:
+
 Scalar Data
 ===========
diff --git a/src/geovista/examples/spatial_index/README.rst b/src/geovista/examples/spatial_index/README.rst
@@ -1,2 +1,4 @@
+.. _gv-examples-spatial-data:
+
 Spatial Index
 =============
diff --git a/src/geovista/examples/unstructured/README.rst b/src/geovista/examples/unstructured/README.rst
@@ -1,2 +1,4 @@
+.. _gv-examples-unstructured:
+
 Unstructured Mesh
 =================
diff --git a/src/geovista/examples/vector_data/README.rst b/src/geovista/examples/vector_data/README.rst
@@ -1,2 +1,4 @@
+.. _gv-examples-vector-data:
+
 Vector Data
 ===========
diff --git a/src/geovista/examples/warp/README.rst b/src/geovista/examples/warp/README.rst
@@ -1,2 +1,4 @@
+.. _gv-examples-warp:
+
 Warp Mesh
 =========
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Added ``sphinx`` cross-references to the :ref:`gv-examples`.
		(:user:`bjlittle`)