docs: add figure alternate text (#964)

bjlittle · Jul 3, 2024 · 9c3d4cc · 9c3d4cc
1 parent b8176f0
commit 9c3d4cc
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/docs/src/next_steps.rst b/docs/src/next_steps.rst
@@ -29,9 +29,11 @@ four distinct needs of documentation users (see :numref:`diátaxis-figure`).
     :figclass: margin
     :target: https://diataxis.fr/
     :name: diátaxis-figure
+    :alt: Diátaxis Axis of Needs
 
     Diátaxis Axes of Needs
 
+
 .. note::
     :class: dropdown
 
@@ -45,6 +47,7 @@ four distinct needs of documentation users (see :numref:`diátaxis-figure`).
     - **Explanation** - Achieve understanding through discussion and reflection.
     - **Reference** - Succinct factual information laid bare.
 
+
 So if you learn by *doing*, then explore our *hands-on* themed lessons or
 topic specific how-tos:
 

diff --git a/docs/src/overview.rst b/docs/src/overview.rst
@@ -36,6 +36,7 @@ Simply put,
 
         "`GeoVista`_ is to `PyVista`_", as "`Cartopy`_ is to `Matplotlib`_"
 
+
 That's our aspiration.
 
 Akin to `Cartopy`_, we intend ``geovista`` to remain as flexible and
@@ -55,9 +56,11 @@ of the GPU.
 .. figure:: _static/images/ecosystem.png
     :align: center
     :name: ecosystem-figure
+    :alt: GeoVista Ecosystem
 
     Ecosystem of ``geovista``
 
+
 As shown above, ``geovista`` is built upon a performant, established, and
 feature rich `VTK`_ toolchain, which is supported and maintained by
 `Kitware`_ and the open-source community.
@@ -73,9 +76,11 @@ PyVista in a Nutshell
     :figclass: margin
     :target: https://docs.pyvista.org/version/stable/examples/
     :name: pyvista-figure
+    :alt: PyVista Examples
 
     PyVista Examples
 
+
 `PyVista`_ is a powerful open-source 3-D visualization library built on
 `VTK`_, providing:
 

diff --git a/docs/src/quick_start.rst b/docs/src/quick_start.rst
@@ -8,6 +8,7 @@
 Now that you've :ref:`installed <gv-installation>` ``geovista``, let's take a
 quick tour to see some of the features and capabilities on offer.
 
+
 Resources
 ---------
 
@@ -24,12 +25,14 @@ following on the command line:
 
     geovista download --all
 
+
 To view the manifest of registered resources:
 
 .. code:: console
 
     geovsita download --list
 
+
 .. note::
     :class: dropdown
 
@@ -55,13 +58,15 @@ Examples
    pyvista.global_theme.axes.show = False
    pyvista.global_theme.anti_aliasing = 'fxaa'
 
+
 .. note::
   :class: margin, dropdown, toggle-shown
 
   The **Interactive Scene**
   `vtk.js <https://kitware.github.io/vtk-js/index.html>`_ backend does **not**
   support rendering text or points as spheres.
 
+
 Let's explore some atmospheric and oceanographic model data using
 ``geovista``, which makes it easy to visualize **rectilinear**,
 **curvilinear**, and **unstructured** meshes.
@@ -162,6 +167,7 @@ projection.
     matures, we'll aim to enrich that capability and complement it with
     other classes of projections, such as **Azimuthal** and **Conic**.
 
+
 .. pyvista-plot::
     :context:
 

diff --git a/docs/src/reference/about.rst b/docs/src/reference/about.rst
@@ -14,6 +14,7 @@ Assorted package metadata about ``geovista``.
     .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7608302.svg
         :target: https://doi.org/10.5281/zenodo.7608302
 
+
 If ``geovista`` has assisted with your academic research or work, then please
 remember to cite us:
 
@@ -30,6 +31,7 @@ remember to cite us:
     Anyone can use the |icon| `all-contributors bot 🤖`_  to acknowledge
     the efforts of others.
 
+
 We follow the |icon| `all-contributors`_ specification. Contributions of
 any kind to ``geovista`` are welcome!