BUG - Fix violation of Axe rule link-name (#1633)

* Fix violation of Axe rule link-name * docs * add link-alt: Brightway * Update docs/user_guide/web-components.rst Co-authored-by: Tania Allard <[email protected]> * indicate that the links go to the docs --------- Co-authored-by: Tania Allard <[email protected]>
pydata · Mar 20, 2024 · 69f827d · 69f827d
1 parent 7b463ab
commit 69f827d
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 1 deletion.
diff --git a/docs/_static/gallery.yaml b/docs/_static/gallery.yaml
@@ -6,38 +6,50 @@
 # This file should only be modified by maintainer, contributors should add their project
 # to the list of `gallery.md`.
 - title: ArviZ
+  link-alt: ArviZ Python docs
   link: https://python.arviz.org/
   img-bottom: ../_static/gallery/arviz.png
 - title: Bokeh
+  link-alt: Bokeh docs
   link: https://docs.bokeh.org/en/latest/
   img-bottom: ../_static/gallery/bokeh.png
 - title: Brightway
+  link-alt: Brightway docs
   link: https://docs.brightway.dev/en/latest/
   img-bottom: ../_static/gallery/brightway.png
 - title: Jupyter
+  link-alt: Jupyter docs
   link: https://docs.jupyter.org/en/latest/
   img-bottom: ../_static/gallery/jupyter.png
 - title: Jupyter Book
+  link-alt: Jupyter Book docs
   link: https://jupyterbook.org/en/stable/intro.html
   img-bottom: ../_static/gallery/jupyter_book.png
 - title: Matplotlib
+  link-alt: Matplotlib docs
   link: https://matplotlib.org/stable/
   img-bottom: ../_static/gallery/matplotlib.png
 - title: MNE-Python
+  link-alt: MNE-Python docs
   link: https://mne.tools/stable/index.html
   img-bottom: ../_static/gallery/mne-python.png
 - title: NetworkX
+  link-alt: NetworkX docs
   link: https://networkx.org/documentation/stable/
   img-bottom: ../_static/gallery/networkx.png
 - title: NumPy
+  link-alt: NumPy docs
   link: https://numpy.org/doc/stable/
   img-bottom: ../_static/gallery/numpy.png
 - title: Pandas
+  link-alt: Pandas docs
   link: https://pandas.pydata.org/docs/
   img-bottom: ../_static/gallery/pandas.png
 - title: SciPy
+  link-alt: SciPy docs
   link: https://docs.scipy.org/doc/scipy/
   img-bottom: ../_static/gallery/scipy.png
 - title: SEPAL
+  link-alt: SEPAL docs
   link: https://docs.sepal.io/en/latest/index.html
   img-bottom: ../_static/gallery/sepal.png
diff --git a/docs/examples/gallery.md b/docs/examples/gallery.md
@@ -24,23 +24,33 @@ Thanks for your support!
 :class-card: "downstream-project-links"
 
 - title: Binder
+  link-alt: Binder docs
   link: https://mybinder.readthedocs.io/en/latest/index.html
 - title: cashocs
+  link-alt: cashocs docs
   link: https://cashocs.readthedocs.io/en/stable/
 - title: CuPy
+  link-alt: CuPy docs
   link: https://docs.cupy.dev/en/stable/index.html
 - title: Fairlearn
+  link-alt: Fairlearn docs
   link: https://fairlearn.org/main/about/
 - title: Feature-engine
+  link-alt: Feature-engine docs
   link: https://feature-engine.readthedocs.io/
 - title: idtracker.ai
+  link-alt: idtracker.ai docs
   link: https://idtracker.ai/
 - title: MegEngine
+  link-alt: MegEngine docs
   link: https://www.megengine.org.cn/doc/stable/en/index.html
 - title: PyVista
+  link-alt: PyVista docs
   link: https://docs.pyvista.org
 - title: Pastas
+  link-alt: Pastas docs
   link: https://pastas.readthedocs.io/
 - title: DecentralChain
+  link-alt: DecentralChain docs
   link: https://docs.decentralchain.io/en/master/
 ```
diff --git a/docs/user_guide/web-components.rst b/docs/user_guide/web-components.rst
@@ -136,7 +136,10 @@ Cards
             Hidden content
 
     .. grid-item-card:: A clickable card
-        :link: https://example.com
+        :link: https://sphinx-design.readthedocs.io/en/pydata-theme/cards.html#clickable-cards
+        :link-alt: Clickable cards - Sphinx Design docs
+
+        Don't forget to add the alternative text with ``link-alt``!
 
 .. grid::