Chore: Fix broken links / satisfy link checker

Author: amotl

CHANGES.md

@@ -7,8 +7,7 @@
 - Dependencies: Added compatibility with sphinx 7 - 9
 
 ## v0.4.0 - 2024-06-27
-- Dependencies: Update to sphinx-design 0.6.0
-  See also [sphinx-design change log].
+- Dependencies: Updated to [sphinx-design 0.6.0]
 - Remove support for Python 3.7 and 3.8, following `sphinx-design`.
 
 ## v0.3.2 - 2024-05-28
@@ -41,4 +40,4 @@
 - Add "tag(s)" shortcuts, using roles `tag` and `tags`
 
 
-[sphinx-design change log]: https://sphinx-design.readthedocs.io/en/furo-theme/changelog.html#v0-6-0-2024-05-23
+[sphinx-design 0.6.0]: https://github.com/executablebooks/sphinx-design/releases/tag/v0.6.0

README.md

@@ -71,7 +71,7 @@ and maintaining [MyST Parser] and [sphinx-design].
 [sphinx-design-elements]: https://sphinx-design-elements.readthedocs.io/
 
 [badge-coverage]: https://codecov.io/gh/tech-writing/sphinx-design-elements/branch/main/graph/badge.svg
-[badge-downloads-per-month]: https://pepy.tech/badge/sphinx-design-elements/month
+[badge-downloads-per-month]: https://static.pepy.tech/badge/sphinx-design-elements/month
 [badge-license]: https://img.shields.io/github/license/tech-writing/sphinx-design-elements.svg
 [badge-docutils-versions]: https://img.shields.io/badge/docutils-0.19%20--%200.22-blue.svg
 [badge-package-version]: https://img.shields.io/pypi/v/sphinx-design-elements.svg
@@ -80,7 +80,7 @@ and maintaining [MyST Parser] and [sphinx-design].
 [badge-status]: https://img.shields.io/pypi/status/sphinx-design-elements.svg
 [badge-tests]: https://github.com/tech-writing/sphinx-design-elements/actions/workflows/main.yml/badge.svg
 [project-codecov]: https://codecov.io/gh/tech-writing/sphinx-design-elements
-[project-downloads]: https://pepy.tech/project/sphinx-design-elements/
+[project-downloads]: https://pepy.tech/project/sphinx-design-elements
 [project-docutils]: https://docutils.sourceforge.io/
 [project-license]: https://github.com/tech-writing/sphinx-design-elements/blob/main/LICENSE
 [project-pypi]: https://pypi.org/project/sphinx-design-elements

docs/backlog.md

@@ -7,7 +7,7 @@ orphan: true
 - Documentation: Render on multiple themes, like `sphinx-design`.
 - From `sphinx-design` 
   - horizontal card (grid row inside card, picture on left)
-  - subtitle for card (see <https://material.io/components/cards#anatomy>)
+  - subtitle for card (see <https://m3.material.io/components/cards/guidelines>)
 - hyper: Maintain a synthetic intersphinx inventory for caching titles from
   extracted HTML pages, so that subsequent invocations do not need to
   extract titles over and over again.

docs/conf.py

@@ -34,6 +34,20 @@
     }
 
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# Configure link checker.
+linkcheck_ignore = [
+    "https://github.com/",
+    "https://jkalina.carrd.co/",
+    "https://simpleicons.org/",
+    "https://unsplash.com/",
+]
+linkcheck_anchors_ignore_for_url = [
+    # Requires JavaScript.
+    # After opting-in to new GitHub issues, Sphinx can no longer grok the HTML anchor references.
+    "https://github.com/",
+]
+
 myst_enable_extensions = [
     "attrs_block",
     "attrs_inline",

docs/infocard.md

@@ -22,7 +22,7 @@ without the maintenance nightmares of tables.
 
 :::{grid-item}
 :columns: 8
-[example.org/beagles](https://example.org/beagles)
+[example.org](https://example.org/)
 
 A module for collecting votes from beagles, \
 and for consolidating them.

docs/snippets/myst/infocard.md

@@ -2,7 +2,7 @@
 
 :::{grid-item}
 :columns: 8
-[example.org/beagles](https://example.org/beagles)
+[example.org](https://example.org/)
 
 A module for collecting votes from beagles, \
 and for consolidating them.

docs/snippets/rst/infocard.rst

@@ -3,7 +3,7 @@
     .. grid-item::
         :columns: 8
 
-        `example.org/beagles <https://example.org/beagles>`_
+        `example.org <https://example.org/>`_
 
         | A module for collecting votes from beagles,
         | and for consolidating them.

tests/test_hyper.py

@@ -21,7 +21,7 @@ def test_hyper_http_url_valid(sphinx_doctree_no_tr: CreateDoctree):
         ptree
         == """
 <reference refuri="https://example.org">
-    Example Domain
+    https://example.org
 """.lstrip()
     )
 
@@ -152,7 +152,7 @@ def test_hyper_button_basic(render):
         == """
 <reference classes="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary" refuri="https://example.org">
     <inline>
-        Example Domain
+        https://example.org
 """.lstrip()
     )
 
@@ -166,7 +166,7 @@ def test_hyper_button_with_icon(render):
     assert '<raw format="html"' in text
     assert '<svg version="1.1"' in text
     assert "example.org" in text
-    assert "Example Domain" in text
+    assert "https://example.org" in text
 
 
 def test_hyper_button_icon_only(render):
@@ -192,7 +192,7 @@ def test_hyper_badge(render):
         == """
 <reference classes="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary" refuri="https://example.org">
     <inline>
-        Example Domain
+        https://example.org
 """.lstrip()
     )
 
@@ -208,7 +208,7 @@ def test_hyper_card_minimal(render):
 <container classes="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover" design_component="card" is_div="True">
     <container classes="sd-card-body" design_component="card-body" is_div="True">
         <paragraph classes="sd-card-text">
-            Example Domain
+            https://example.org
     <PassthroughTextElement>
         <reference classes="sd-stretched-link sd-hide-link-text" refuri="https://example.org">
             <inline>
@@ -234,7 +234,7 @@ def test_hyper_card_full(render):
             <PassthroughTextElement>
                 title
         <paragraph classes="sd-card-text">
-            Example Domain
+            https://example.org
     <container classes="sd-card-footer" design_component="card-footer" is_div="True">
         <paragraph classes="sd-card-text">
             footer

tests/test_snippets/snippet_myst_post_infocard.xml

@@ -10,8 +10,8 @@
                             <container classes="sd-row sd-m-0 sd-p-0" design_component="grid-row" is_div="True">
                                 <container classes="sd-col sd-d-flex-column sd-col-8 sd-col-xs-8 sd-col-sm-8 sd-col-md-8 sd-col-lg-8" design_component="grid-item" is_div="True">
                                     <paragraph>
-                                        <reference refuri="https://example.org/beagles">
-                                            example.org/beagles
+                                        <reference refuri="https://example.org/">
+                                            example.org
                                     <paragraph>
                                         A module for collecting votes from beagles, 
                                         <raw format="html" xml:space="preserve">

tests/test_snippets/snippet_myst_pre_infocard.xml

@@ -10,8 +10,8 @@
                             <container classes="sd-row sd-m-0 sd-p-0" design_component="grid-row" is_div="True">
                                 <container classes="sd-col sd-d-flex-column sd-col-8 sd-col-xs-8 sd-col-sm-8 sd-col-md-8 sd-col-lg-8" design_component="grid-item" is_div="True">
                                     <paragraph>
-                                        <reference refuri="https://example.org/beagles">
-                                            example.org/beagles
+                                        <reference refuri="https://example.org/">
+                                            example.org
                                     <paragraph>
                                         A module for collecting votes from beagles, 
                                         <raw format="html" xml:space="preserve">