-
-
Notifications
You must be signed in to change notification settings - Fork 66
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
Check for broken links #267
Comments
I'm glad I found the broken link 😅. These tools look very interesting and I'll definitely be using them. Thanks @kinow !! |
@kinow should we close this out - or would you like to integrate the first suggestion into the build process so we check every time? |
I won't have time for now, but maybe somebody else could be interested in implementing a check for that. Maybe it could be fine-tuned to verify links for certain domains (e.g. commonwl.org), or just scan every link, etc. |
@Mackenzie-OO7 and @Fienne would you be interested in adding a check for this? |
Yes, I would. |
@Fienne found a broken link in the user guide. That reminded me of two tools that can be used for finding issues like this. The second can also be used to prevent, by hooking it up in our CI system.
It checks anchors, internal, and external links. You need to provide the parameters that can be saved in a cookie locally. It takes a few seconds/minutes, but gives you a pretty detailed report to go through and fix any broken links.
Not sure if it can be configured to inspect external links. It checks anchors and internal links. Comes with Sphinx. It is a builder like the
html
builder. Here's an example run, grep'ing for the token "broken":I did not check if the links are indeed broken. But we used it in the Cylc project (I believe they still use it, and for external links? → https://github.com/cylc/cylc-doc/blob/5a5aaa111c6756fdf7c4ab9b2f8ec6cabd37ae6e/src/conf.py#L136-L140).
@swzCuroverse maybe a good one for Outreachy? A little harder to work on this as it requires some researching into how Sphinx works (although it should be nerdily fun! 🤓 ).
-Bruno
The text was updated successfully, but these errors were encountered: