Add linkcheck step to be run once a week #474
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Can also be triggered manually. It creates an issue when broken links are found in the documentation, including docstrings.
|
(I will get started on fixing the links currently flagged by the action) |
|
Hi all, any feedback here? |
|
Shoot sorry to overlook this. I think link checking is a great idea. |
psobolewskiPhD
approved these changes
Aug 22, 2024
|
Let me submit a PR to fix the existing failures first so we don't get spammed by the failures :D |
DragaDoncila
pushed a commit
that referenced
this pull request
Oct 23, 2024
# References and relevant issues Related to #474 # Description Fixes a number of broken links detected by `make linkcheck-files`. A few comments: - it looks like this link does not exist anymore: `further-resources/sample_data.md:17: [redirected permanently] [digitalpathologyassociation.org/whole-slide-imaging-repository](https://digitalpathologyassociation.org/whole-slide-imaging-repository) to [https://digitalpathologyassociation.org?preview_error](https://digitalpathologyassociation.org/?preview_error)`. I tried googling but only found this: http://www.wsirepository.org/ and it doesn't load. Any ideas? - How can we replace the following link? `developers/architecture/app_model.md:288: [broken] https://github.com/napari/napari/blob/main/napari/_app_model/_submenus.py: 404 Client Error: Not Found for url: https://github.com/napari/napari/blob/main/napari/_app_model/_submenus.py` I couldn't find SubmenuItem in the codebase, maybe I'm missing something - https://github.com/potating-potato has probably deleted their github account. I suggest we convert the links to static text if we want to preserve history. - These hackmd docs seem to only be readable if you are logged in: https://hackmd.io/fmKp0If5RkiwWIxYYRdKpg and https://hackmd.io/@talley/SJB_lObBi#What-is-a-virtual-environment Should we make it readable by all, or ignore in the linkcheck? - A few links will need to be fixed in npe2, I'll send a follow-up PR for that. - This file does not seem to exist anymore, from a search at the btrack repo: `tutorials/tracking/cell_tracking.md:229: [broken] https://github.com/quantumjot/btrack/blob/main/models/cell_config.json: 404 Client Error: Not Found for url: https://github.com/quantumjot/btrack/blob/main/models/cell_config.json`. Should we replace with a new link? - I will add a regex to ignore redirects from docs paths to stuff like "stable/" or "en/latest" A few items are left, mostly links to old code. I will try to replace with permalinks where I can, but not sure if I'll be able to find all of them. If that's the case I might try to ping the original authors for an appropriate substitution. --------- Co-authored-by: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
References and relevant issues
Closes #439
Closes #328
Depends on #484
Description
Adds a sphinx linkcheck step to be run once a week. The reported failures will show up as issues in the repo.
This check can also be triggered manually. I am using the sphinx linkchecker as it will check all links in the docs, including those coming from docstrings.
You can see this in action on my fork, here:
melissawm#16