call them button-links

pydata · Oct 3, 2023 · 10c2090 · 10c2090
1 parent 95f46a1
commit 10c2090
Showing 1 changed file with 12 additions and 3 deletions.
diff --git a/docs/user_guide/web-components.rst b/docs/user_guide/web-components.rst
@@ -17,8 +17,8 @@ Below you can find some examples of the components created with the :code:`sphin
 
 .. _badges-buttons:
 
-Badges and buttons
-==================
+Badges and button-links
+=======================
 
 Here are some of the available badges:
 
@@ -29,7 +29,7 @@ Here are some of the available badges:
 :bdg-secondary-line:`secondary outline`
 :bdg-success-line:`success outline`
 
-Here are some of the available buttons, also using semantic colors:
+Here are some of the available button-style links, also using semantic colors:
 
 .. grid:: auto
 
@@ -96,6 +96,15 @@ Here are some of the available buttons, also using semantic colors:
 
             Dark
 
+.. note::
+
+   `Sphinx Design buttons
+   <https://sphinx-design.readthedocs.io/en/latest/badges_buttons.html>`__
+   are actually links, meaning they are rendered in HTML with ``<a>`` tags
+   instead of ``<button>``. Use them if you need a link to look like a button,
+   but we discourage this usage because it is not considered good practice for
+   accessibility.
+
 If in your site's `custom CSS file <custom-css>`_ you override the `CSS custom properties <css-variables>`_ ``--pst-color-*`` (where ``*`` is one of the semantic color names, such as ``primary``, ``danger``), badges and buttons will automatically use the custom color.
 
 Cards