From 062c42f60c27c76686aefc113cf44115ee90a77a Mon Sep 17 00:00:00 2001 From: gabalafou Date: Fri, 5 Jan 2024 22:18:19 -0500 Subject: [PATCH 1/5] Fix violation of Axe rule link-name --- docs/_static/gallery.yaml | 11 +++++++++++ docs/examples/gallery.md | 11 +++++++++++ docs/user_guide/web-components.rst | 1 + 3 files changed, 23 insertions(+) diff --git a/docs/_static/gallery.yaml b/docs/_static/gallery.yaml index f821315d2..cfbf1d706 100644 --- a/docs/_static/gallery.yaml +++ b/docs/_static/gallery.yaml @@ -6,35 +6,46 @@ # This file should only be modified by maintainer, contributors should add their project # to the list of `gallery.md`. - title: ArviZ + link-alt: ArviZ link: https://python.arviz.org/ img-bottom: ../_static/gallery/arviz.png - title: Bokeh + link-alt: Bokeh link: https://docs.bokeh.org/en/latest/ img-bottom: ../_static/gallery/bokeh.png - title: Jupyter + link-alt: Jupyter link: https://docs.jupyter.org/en/latest/ img-bottom: ../_static/gallery/jupyter.png - title: Jupyter Book + link-alt: Jupyter Book link: https://jupyterbook.org/en/stable/intro.html img-bottom: ../_static/gallery/jupyter_book.png - title: Matplotlib + link-alt: Matplotlib link: https://matplotlib.org/stable/ img-bottom: ../_static/gallery/matplotlib.png - title: MNE-Python + link-alt: MNE-Python link: https://mne.tools/stable/index.html img-bottom: ../_static/gallery/mne-python.png - title: NetworkX + link-alt: NetworkX link: https://networkx.org/documentation/stable/ img-bottom: ../_static/gallery/networkx.png - title: NumPy + link-alt: NumPy link: https://numpy.org/doc/stable/ img-bottom: ../_static/gallery/numpy.png - title: Pandas + link-alt: Pandas link: https://pandas.pydata.org/docs/ img-bottom: ../_static/gallery/pandas.png - title: SciPy + link-alt: SciPy link: https://docs.scipy.org/doc/scipy/ img-bottom: ../_static/gallery/scipy.png - title: SEPAL + link-alt: SEPAL 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 index 888b6d416..1a7ef9153 100644 --- a/docs/examples/gallery.md +++ b/docs/examples/gallery.md @@ -24,25 +24,36 @@ Thanks for your support! :class-card: "downstream-project-links" - title: Binder + link-alt: Binder link: https://mybinder.readthedocs.io/en/latest/index.html - title: Brightway + link-alt: Brightway link: https://docs.brightway.dev/en/latest/ - title: cashocs + link-alt: cashocs link: https://cashocs.readthedocs.io/en/stable/ - title: CuPy + link-alt: CuPy link: https://docs.cupy.dev/en/stable/index.html - title: Fairlearn + link-alt: Fairlearn link: https://fairlearn.org/main/about/ - title: Feature-engine + link-alt: Feature-engine link: https://feature-engine.readthedocs.io/ - title: idtracker.ai + link-alt: idtracker.ai link: https://idtracker.ai/ - title: MegEngine + link-alt: MegEngine link: https://www.megengine.org.cn/doc/stable/en/index.html - title: PyVista + link-alt: PyVista link: https://docs.pyvista.org - title: Pastas + link-alt: Pastas link: https://pastas.readthedocs.io/ - title: DecentralChain + link-alt: DecentralChain link: https://docs.decentralchain.io/en/master/ ``` diff --git a/docs/user_guide/web-components.rst b/docs/user_guide/web-components.rst index 7a96cb355..d65290e47 100644 --- a/docs/user_guide/web-components.rst +++ b/docs/user_guide/web-components.rst @@ -137,6 +137,7 @@ Cards .. grid-item-card:: A clickable card :link: https://example.com + :link-alt: A clickable card .. grid:: From 07f9f3f4b91ea28980651c6d9b7b539197efe7f9 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Fri, 5 Jan 2024 23:13:20 -0500 Subject: [PATCH 2/5] docs --- docs/user_guide/web-components.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/user_guide/web-components.rst b/docs/user_guide/web-components.rst index d65290e47..9a5356f21 100644 --- a/docs/user_guide/web-components.rst +++ b/docs/user_guide/web-components.rst @@ -136,8 +136,10 @@ Cards Hidden content .. grid-item-card:: A clickable card - :link: https://example.com - :link-alt: A clickable card + :link: https://sphinx-design.readthedocs.io/en/pydata-theme/cards.html#clickable-cards + :link-alt: Clickable cards - Sphinx Design docs + + Don't forget ``link-alt``! .. grid:: From 55f38f3795336be2cfd44ef14221a2cc1e040d77 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Wed, 21 Feb 2024 16:45:48 -0500 Subject: [PATCH 3/5] add link-alt: Brightway --- docs/_static/gallery.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/_static/gallery.yaml b/docs/_static/gallery.yaml index ceaf238c4..5125c6fb7 100644 --- a/docs/_static/gallery.yaml +++ b/docs/_static/gallery.yaml @@ -14,6 +14,7 @@ link: https://docs.bokeh.org/en/latest/ img-bottom: ../_static/gallery/bokeh.png - title: Brightway + link-alt: Brightway link: https://docs.brightway.dev/en/latest/ img-bottom: ../_static/gallery/brightway.png - title: Jupyter From 8098c75b22581970daf818c4d7b35ac1390f8e49 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Mon, 26 Feb 2024 17:04:13 -0600 Subject: [PATCH 4/5] Update docs/user_guide/web-components.rst Co-authored-by: Tania Allard --- docs/user_guide/web-components.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user_guide/web-components.rst b/docs/user_guide/web-components.rst index 9a5356f21..8527d5e20 100644 --- a/docs/user_guide/web-components.rst +++ b/docs/user_guide/web-components.rst @@ -139,7 +139,7 @@ Cards :link: https://sphinx-design.readthedocs.io/en/pydata-theme/cards.html#clickable-cards :link-alt: Clickable cards - Sphinx Design docs - Don't forget ``link-alt``! + Don't forget to add the alternative text with ``link-alt``! .. grid:: From c03525e3d2fd1f1ee9c42d7da935693b14b65177 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Fri, 15 Mar 2024 14:07:59 -0500 Subject: [PATCH 5/5] indicate that the links go to the docs --- docs/_static/gallery.yaml | 24 ++++++++++++------------ docs/examples/gallery.md | 20 ++++++++++---------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/_static/gallery.yaml b/docs/_static/gallery.yaml index 5125c6fb7..c310567e6 100644 --- a/docs/_static/gallery.yaml +++ b/docs/_static/gallery.yaml @@ -6,50 +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 + link-alt: ArviZ Python docs link: https://python.arviz.org/ img-bottom: ../_static/gallery/arviz.png - title: Bokeh - link-alt: Bokeh + link-alt: Bokeh docs link: https://docs.bokeh.org/en/latest/ img-bottom: ../_static/gallery/bokeh.png - title: Brightway - link-alt: Brightway + link-alt: Brightway docs link: https://docs.brightway.dev/en/latest/ img-bottom: ../_static/gallery/brightway.png - title: Jupyter - link-alt: 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 + 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 + link-alt: Matplotlib docs link: https://matplotlib.org/stable/ img-bottom: ../_static/gallery/matplotlib.png - title: MNE-Python - link-alt: 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 + link-alt: NetworkX docs link: https://networkx.org/documentation/stable/ img-bottom: ../_static/gallery/networkx.png - title: NumPy - link-alt: NumPy + link-alt: NumPy docs link: https://numpy.org/doc/stable/ img-bottom: ../_static/gallery/numpy.png - title: Pandas - link-alt: Pandas + link-alt: Pandas docs link: https://pandas.pydata.org/docs/ img-bottom: ../_static/gallery/pandas.png - title: SciPy - link-alt: SciPy + link-alt: SciPy docs link: https://docs.scipy.org/doc/scipy/ img-bottom: ../_static/gallery/scipy.png - title: SEPAL - link-alt: 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 index 64f92f537..755c63661 100644 --- a/docs/examples/gallery.md +++ b/docs/examples/gallery.md @@ -24,33 +24,33 @@ Thanks for your support! :class-card: "downstream-project-links" - title: Binder - link-alt: Binder + link-alt: Binder docs link: https://mybinder.readthedocs.io/en/latest/index.html - title: cashocs - link-alt: cashocs + link-alt: cashocs docs link: https://cashocs.readthedocs.io/en/stable/ - title: CuPy - link-alt: CuPy + link-alt: CuPy docs link: https://docs.cupy.dev/en/stable/index.html - title: Fairlearn - link-alt: Fairlearn + link-alt: Fairlearn docs link: https://fairlearn.org/main/about/ - title: Feature-engine - link-alt: Feature-engine + link-alt: Feature-engine docs link: https://feature-engine.readthedocs.io/ - title: idtracker.ai - link-alt: idtracker.ai + link-alt: idtracker.ai docs link: https://idtracker.ai/ - title: MegEngine - link-alt: MegEngine + link-alt: MegEngine docs link: https://www.megengine.org.cn/doc/stable/en/index.html - title: PyVista - link-alt: PyVista + link-alt: PyVista docs link: https://docs.pyvista.org - title: Pastas - link-alt: Pastas + link-alt: Pastas docs link: https://pastas.readthedocs.io/ - title: DecentralChain - link-alt: DecentralChain + link-alt: DecentralChain docs link: https://docs.decentralchain.io/en/master/ ```