add sphinx-design gallery card

bjlittle · Dec 4, 2023 · fa8bc18 · fa8bc18
1 parent afcc309
commit fa8bc18
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/docs/src/_static/images/icons/gallery.svg b/docs/src/_static/images/icons/gallery.svg
diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -46,6 +46,7 @@
     "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
     "sphinx_copybutton",
+    "sphinx_design",
     "sphinx_gallery.gen_gallery",
     "pyvista.ext.viewer_directive",
 ]

diff --git a/docs/src/index.rst b/docs/src/index.rst
@@ -10,7 +10,16 @@
    </h4>
    <br>
 
-We're just bootstrapping ``geovista`` and its documentation, so please be patient 👍
+.. card:: Gallery
+   :text-align: center
+   :link: gallery
+   :link-type: ref
+   :img-top: _static/images/icons/gallery.svg
+   :width: 25%
+   :margin: 0 5 auto auto
+   :class-title: sd-fs-3
+
+We're just starting to populate the documentation, so the content will evolve over time ...
 
 .. toctree::
    :maxdepth: 1

diff --git a/src/geovista/examples/README.rst b/src/geovista/examples/README.rst
@@ -1,4 +1,6 @@
+.. _gallery:
+
 Gallery
 =======
 
-GeoVista example gallery.
+An interactive gallery of the ``geovista.examples``.