You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The linkchecker that we use at the moment does not seem to check external links hence #5379 and others
I tried turning on the sphinx linkchecker python make.py linkcheck which seems to work but generate a fair number of redirect warnings and errors. Perhaps it is worth turning this on pr default?
When I ran this, github temporarily blocked me because of suspected abuse due to many page requests. Possible workaround add linkcheck_ignore = [r'https://github.com/.*'] to conf.py.
Is too much traffic a general concern if we run this with with every CI build?
There's a lot of output and the link checks must be filtered out. Either there has to be a way to silence sphinx mostly or one would have to grep the results.
This issue has been marked "inactive" because it has been 365 days since the last comment. If this issue is still present in recent Matplotlib releases, or the feature request is still wanted, please leave a comment and this label will be removed. If there are no updates in another 30 days, this issue will be automatically closed, but you are free to re-open or create a new issue if needed. We value issue reports, and this procedure is meant to help us resurface and prioritize issues that have not been addressed yet, not make them disappear. Thanks for your help!
This issue has been marked "inactive" because it has been 365 days since the last comment. If this issue is still present in recent Matplotlib releases, or the feature request is still wanted, please leave a comment and this label will be removed. If there are no updates in another 30 days, this issue will be automatically closed, but you are free to re-open or create a new issue if needed. We value issue reports, and this procedure is meant to help us resurface and prioritize issues that have not been addressed yet, not make them disappear. Thanks for your help!
The best path here is what @rcomer suggests: have a weekly or monthly job that runs the checks. We should copy the preselease job and have it open an issue on failure.
Marking as good first issue because there should be no library changes. The steps are
understand how to run the link checker locally
fix any broken links
understand how to run the link checker on GHA
set up low-ferquency cron job that creates an issues on failure
This issue is suited to new contributors because it does not require understanding of the
Matplotlib internals. To get started, please see our contributing
guide.
We do not assign issues. Check the Development section in the sidebar for linked pull
requests (PRs). If there are none, feel free to start working on it. If there is an open PR, please
collaborate on the work by reviewing it rather than duplicating it in a competing PR.
On MetPy we have a script that can be used to filter only to links added in the most recent merge so you can check links in a PR. Then the nightly/unstable build checks all the links.
FWIW the other project I mentioned just moved to link checking in a scheduled action, using something called lychee. This is all I know. SciTools/iris#6386
@jenshnielsen Hi! I’d like to help with enabling the Sphinx link checker for the documentation build. Is anyone currently working on this, or can I get started? Any tips or preferred approach?
I think both of the latest suggestions (identifying new links and checking them in the PR and a scheduled job that opens issues) are worth perusing.
The biggest issue with any of these checkers is that our docs contain a lot of links which is both time consuming and runs the risk of looking like a malicious actor (both from GHA looking at what is going out and inbound on sites we link to).
@tacaswell Thanks for the feedback! I’ll look into both approaches—checking new links in PRs and setting up a scheduled job to report broken links. I’ll also review how Sphinx linkcheck can be integrated into the CI while minimizing unnecessary requests. If I have any questions or need guidance, I’ll reach out here. Appreciate the suggestions!
Activity
[-]Turn on Sphinx Link checker on Travis[/-][+]Turn on Sphinx Link checker on Travis?[/+]mdboom commentedon Nov 2, 2015
Thanks. I didn't realize we weren't checking external links, so this is great. Also solves the problem that
linkcheckerdoesn't work on Python 3.x.tacaswell commentedon Nov 2, 2015
Huh, nifty that sphinx has that functionality built in....
timhoffm commentedon Apr 13, 2020
How it works: Essentially, from
docsrunOpen issues:
linkcheck_ignore = [r'https://github.com/.*']toconf.py.Is too much traffic a general concern if we run this with with every CI build?
[-]Turn on Sphinx Link checker on Travis?[/-][+]Turn on Sphinx Link checker on CI?[/+]github-actions commentedon Jun 2, 2023
This issue has been marked "inactive" because it has been 365 days since the last comment. If this issue is still present in recent Matplotlib releases, or the feature request is still wanted, please leave a comment and this label will be removed. If there are no updates in another 30 days, this issue will be automatically closed, but you are free to re-open or create a new issue if needed. We value issue reports, and this procedure is meant to help us resurface and prioritize issues that have not been addressed yet, not make them disappear. Thanks for your help!
5 remaining items
github-actions commentedon Jun 3, 2024
This issue has been marked "inactive" because it has been 365 days since the last comment. If this issue is still present in recent Matplotlib releases, or the feature request is still wanted, please leave a comment and this label will be removed. If there are no updates in another 30 days, this issue will be automatically closed, but you are free to re-open or create a new issue if needed. We value issue reports, and this procedure is meant to help us resurface and prioritize issues that have not been addressed yet, not make them disappear. Thanks for your help!
tacaswell commentedon Jun 3, 2024
The best path here is what @rcomer suggests: have a weekly or monthly job that runs the checks. We should copy the preselease job and have it open an issue on failure.
Marking as good first issue because there should be no library changes. The steps are
github-actions commentedon Jun 3, 2024
Good first issue - notes for new contributors
This issue is suited to new contributors because it does not require understanding of the
Matplotlib internals. To get started, please see our contributing
guide.
We do not assign issues. Check the Development section in the sidebar for linked pull
requests (PRs). If there are none, feel free to start working on it. If there is an open PR, please
collaborate on the work by reviewing it rather than duplicating it in a competing PR.
If something is unclear, please reach out on any of our communication
channels.
dopplershift commentedon Jun 3, 2024
On MetPy we have a script that can be used to filter only to links added in the most recent merge so you can check links in a PR. Then the nightly/unstable build checks all the links.
rcomer commentedon Mar 28, 2025
FWIW the other project I mentioned just moved to link checking in a scheduled action, using something called lychee. This is all I know. SciTools/iris#6386
Edit: and it made its first report SciTools/iris#6390
immortal71 commentedon Nov 16, 2025
@jenshnielsen Hi! I’d like to help with enabling the Sphinx link checker for the documentation build. Is anyone currently working on this, or can I get started? Any tips or preferred approach?
tacaswell commentedon Nov 16, 2025
I think both of the latest suggestions (identifying new links and checking them in the PR and a scheduled job that opens issues) are worth perusing.
The biggest issue with any of these checkers is that our docs contain a lot of links which is both time consuming and runs the risk of looking like a malicious actor (both from GHA looking at what is going out and inbound on sites we link to).
immortal71 commentedon Nov 17, 2025
@tacaswell Thanks for the feedback! I’ll look into both approaches—checking new links in PRs and setting up a scheduled job to report broken links. I’ll also review how Sphinx linkcheck can be integrated into the CI while minimizing unnecessary requests. If I have any questions or need guidance, I’ll reach out here. Appreciate the suggestions!
ci: add scheduled sphinx linkcheck workflow
tacaswell commentedon Feb 25, 2026
I took off good first issue to not draw any more AI spam to this issue.