-
-
Notifications
You must be signed in to change notification settings - Fork 7
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
Add automatic link checking #12
Comments
I believe mkdocs raises a warning when it finds a link like this. The repo is setup to abort if any warnings are raised, which should cover this. We should do some proper testing to ensure this actually works, though. |
Hrm, mkdocs/mkdocs#192 (comment) hints that to get the automatic validation we should have our links end with |
Since the fix to #17, I think this is now about as well sorted as we can get without adding something of our own on top. I realise this issue was originally about doing that, however the value that adds is fairly limited now we've got Closing this as no longer useful, though happy to be disagreed with if there's a strong feeling we need something more. |
While
mkdocs
tries to catch broken internal links, it doesn't seem to completely succeed. It would be great if we could catch broken links during CI.Note: if there are options to
mkdocs
to make this stricter/fail more loudly that we're missing, that's a viable (and probably the best) solution.The text was updated successfully, but these errors were encountered: