-
Notifications
You must be signed in to change notification settings - Fork 213
fix failing tests related to broken links #680
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.
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
Conversation
Add linkcheck_anchors_ignore setting to skip GitHub's dynamic comment anchors during documentation link validation. This prevents false positives in CI when checking links to GitHub issue comments, as GitHub injects these anchors dynamically in the web interface.
This PR addresses the link check failures from #678. The workflow needs maintainer approval to proceed. Once reviewed and approved, it should resolve the CI failures. Thanks! |
I didn't follow on what pytest-cov is checking here, but maybe as a one-off check, there exists a link (and email) linter called lychee, quite fast especially with caching, that could be appropriate to spot all the broken external (and internal if configured) links. You could take a look to see if it would help you. |
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Thanks everyone! @webknjaz, I believe that I've addressed your requested changes. Please let me know if there's anything else you'd like me to adjust. @echoix, thanks for the suggestion about using lychee. If it's beneficial, perhaps the pytest-cov team will consider integrating it in the future, but it's out of scope for this PR. If a maintainer could approve the workflow when convenient, that would be great. I'm here to make any additional changes as needed. |
also, on my machine it fails with |
Yeah, that must be flaky |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
as suggested in #678
Edit:
This PR addresses issues related to the Sphinx link checker and updates outdated links to resolve failing tests.
Changes Made
Link Check Configuration:
GitHub has changed the way anchors are injected into web pages, causing the Sphinx link checker to fail. This configuration update allows us to skip anchor checking for GitHub URLs, preventing unnecessary build failures.
Updated Links:
The http://firelet.net URL is no longer accessible, causing Sphinx's link checker to generate build errors. Adjusted to conform with others in the file that are escaped with backslashes.