Skip to content

Chore: Satisfy link checker by ignoring example.org #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amotl merged 2 commits into from
Feb 25, 2026
Merged

Chore: Satisfy link checker by ignoring example.org #174

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6476614
Chore: Satisfy link checker by ignoring example.org
amotl Feb 25, 2026
ce824d9
Chore: Satisfy link checker by ignoring docutils.sourceforge.io
amotl Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@
"https://jkalina.carrd.co/",
"https://simpleicons.org/",
"https://unsplash.com/",
"https://example.org",
Copy link

@coderabbitai coderabbitai bot Feb 25, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add trailing slash to "https://example.org" for consistency.

Every other entry in linkcheck_ignore uses a trailing slash as a prefix delimiter. While re.search() makes this functionally equivalent for sub-path matching, the missing slash is an inconsistency worth aligning.

✏️ Proposed fix 
-    "https://example.org",
+    "https://example.org/",
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"https://example.org",
"https://example.org/",
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/conf.py` at line 44, In the linkcheck_ignore list update the entry
"https://example.org" to include a trailing slash ("https://example.org/") for
consistency with other prefixes; locate the linkcheck_ignore definition in
docs/conf.py and replace the existing string so all entries use a trailing slash
prefix, keeping the surrounding list formatting intact.

Copy link
Member Author

@amotl amotl Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, but no: It would defy the pattern matching. Been there, seen that.

Copy link

@coderabbitai coderabbitai bot Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amotl, understood! Thank you for the clarification. I appreciate you sharing that insight about the pattern matching behavior—it makes sense that the trailing slash affects how the patterns are matched in Sphinx's linkcheck configuration.

(\\_/)
(o.o)
(> <)  *learning noted*
✏️ Learnings added 
Learnt from: amotl
Repo: tech-writing/sphinx-design-elements PR: 174
File: docs/conf.py:44-44
Timestamp: 2026-02-25T14:21:43.759Z
Learning: In Sphinx documentation configuration (docs/conf.py), the linkcheck_ignore list uses pattern matching where the presence or absence of a trailing slash affects matching behavior. For example, "https://example.org" (without trailing slash) may be needed to properly match the domain and all its paths, while adding a trailing slash could break the pattern matching. Developers with experience in this codebase have noted this specific behavior.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

"https://docutils.sourceforge.io/",
]
linkcheck_anchors_ignore_for_url = [
# Requires JavaScript.
Expand Down