From fa8bc187b27f0c2ff3d2561c24712266101c05b5 Mon Sep 17 00:00:00 2001 From: Bill Little Date: Mon, 4 Dec 2023 22:26:19 +0000 Subject: [PATCH] add sphinx-design gallery card --- docs/src/_static/images/icons/gallery.svg | 1 + docs/src/conf.py | 1 + docs/src/index.rst | 11 ++++++++++- src/geovista/examples/README.rst | 4 +++- 4 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 docs/src/_static/images/icons/gallery.svg diff --git a/docs/src/_static/images/icons/gallery.svg b/docs/src/_static/images/icons/gallery.svg new file mode 100644 index 00000000..0cec82a0 --- /dev/null +++ b/docs/src/_static/images/icons/gallery.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/src/conf.py b/docs/src/conf.py index f1856224..1ec1068e 100644 --- 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 index 45684f5c..96461998 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -10,7 +10,16 @@
-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 index f47f9c7e..94127f0e 100644 --- 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``.