diff --git a/changelog/1304.contributor.rst b/changelog/1304.contributor.rst new file mode 100644 index 00000000..13040fe0 --- /dev/null +++ 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 index 4c8b89c2..eb944e8b 100644 --- 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 `. +``geovista`` :ref:`Gallery Examples `. These packages may be installed with: diff --git a/docs/src/next_steps.rst b/docs/src/next_steps.rst index b8357c97..d9b41d53 100644 --- 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 index 083b56e3..71cab76f 100644 --- 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 index bcb3ff61..07e0f98e 100644 --- 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 index a71a3bd9..90ec8d7c 100644 --- 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 index c93c352c..3d814efa 100644 --- 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 index 1ab7f649..f61abaca 100644 --- 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 index b30fd7dc..d329abd7 100644 --- 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 index 9950bbd6..f890c90b 100644 --- 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 index 9ce31b11..079d4391 100644 --- 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 index 098f9a4e..524a535b 100644 --- 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 index 9f5d899c..60be6e83 100644 --- a/src/geovista/examples/warp/README.rst +++ b/src/geovista/examples/warp/README.rst @@ -1,2 +1,4 @@ +.. _gv-examples-warp: + Warp Mesh =========