Skip to content

Commit 69f827d

Browse files
gabalafoutrallard
andauthored
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]>
1 parent 7b463ab commit 69f827d

File tree

3 files changed

+26
-1
lines changed

3 files changed

+26
-1
lines changed

docs/_static/gallery.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,50 @@
66
# This file should only be modified by maintainer, contributors should add their project
77
# to the list of `gallery.md`.
88
- title: ArviZ
9+
link-alt: ArviZ Python docs
910
link: https://python.arviz.org/
1011
img-bottom: ../_static/gallery/arviz.png
1112
- title: Bokeh
13+
link-alt: Bokeh docs
1214
link: https://docs.bokeh.org/en/latest/
1315
img-bottom: ../_static/gallery/bokeh.png
1416
- title: Brightway
17+
link-alt: Brightway docs
1518
link: https://docs.brightway.dev/en/latest/
1619
img-bottom: ../_static/gallery/brightway.png
1720
- title: Jupyter
21+
link-alt: Jupyter docs
1822
link: https://docs.jupyter.org/en/latest/
1923
img-bottom: ../_static/gallery/jupyter.png
2024
- title: Jupyter Book
25+
link-alt: Jupyter Book docs
2126
link: https://jupyterbook.org/en/stable/intro.html
2227
img-bottom: ../_static/gallery/jupyter_book.png
2328
- title: Matplotlib
29+
link-alt: Matplotlib docs
2430
link: https://matplotlib.org/stable/
2531
img-bottom: ../_static/gallery/matplotlib.png
2632
- title: MNE-Python
33+
link-alt: MNE-Python docs
2734
link: https://mne.tools/stable/index.html
2835
img-bottom: ../_static/gallery/mne-python.png
2936
- title: NetworkX
37+
link-alt: NetworkX docs
3038
link: https://networkx.org/documentation/stable/
3139
img-bottom: ../_static/gallery/networkx.png
3240
- title: NumPy
41+
link-alt: NumPy docs
3342
link: https://numpy.org/doc/stable/
3443
img-bottom: ../_static/gallery/numpy.png
3544
- title: Pandas
45+
link-alt: Pandas docs
3646
link: https://pandas.pydata.org/docs/
3747
img-bottom: ../_static/gallery/pandas.png
3848
- title: SciPy
49+
link-alt: SciPy docs
3950
link: https://docs.scipy.org/doc/scipy/
4051
img-bottom: ../_static/gallery/scipy.png
4152
- title: SEPAL
53+
link-alt: SEPAL docs
4254
link: https://docs.sepal.io/en/latest/index.html
4355
img-bottom: ../_static/gallery/sepal.png

docs/examples/gallery.md

+10
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,33 @@ Thanks for your support!
2424
:class-card: "downstream-project-links"
2525
2626
- title: Binder
27+
link-alt: Binder docs
2728
link: https://mybinder.readthedocs.io/en/latest/index.html
2829
- title: cashocs
30+
link-alt: cashocs docs
2931
link: https://cashocs.readthedocs.io/en/stable/
3032
- title: CuPy
33+
link-alt: CuPy docs
3134
link: https://docs.cupy.dev/en/stable/index.html
3235
- title: Fairlearn
36+
link-alt: Fairlearn docs
3337
link: https://fairlearn.org/main/about/
3438
- title: Feature-engine
39+
link-alt: Feature-engine docs
3540
link: https://feature-engine.readthedocs.io/
3641
- title: idtracker.ai
42+
link-alt: idtracker.ai docs
3743
link: https://idtracker.ai/
3844
- title: MegEngine
45+
link-alt: MegEngine docs
3946
link: https://www.megengine.org.cn/doc/stable/en/index.html
4047
- title: PyVista
48+
link-alt: PyVista docs
4149
link: https://docs.pyvista.org
4250
- title: Pastas
51+
link-alt: Pastas docs
4352
link: https://pastas.readthedocs.io/
4453
- title: DecentralChain
54+
link-alt: DecentralChain docs
4555
link: https://docs.decentralchain.io/en/master/
4656
```

docs/user_guide/web-components.rst

+4-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,10 @@ Cards
136136
Hidden content
137137

138138
.. grid-item-card:: A clickable card
139-
:link: https://example.com
139+
:link: https://sphinx-design.readthedocs.io/en/pydata-theme/cards.html#clickable-cards
140+
:link-alt: Clickable cards - Sphinx Design docs
141+
142+
Don't forget to add the alternative text with ``link-alt``!
140143

141144
.. grid::
142145

0 commit comments

Comments
 (0)