-
Notifications
You must be signed in to change notification settings - Fork 148
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
[Docs] Add link checker for docs #475
Conversation
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
The INCITS link has gone! I found one on the NIST website https://nvlpubs.nist.gov/nistpubs/ir/2021/NIST.IR.8366.pdf but I think we'll follow Google as a more accessible standard. |
Added a commit with a link that works, to replace the one broken within the docs style guidelines. |
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.
Looks good!
Signed-off-by: Antony Milne <[email protected]>
Signed-off-by: Antony Milne <[email protected]>
Description
Add a link checking step to the build of both vizro-ai and vizro-core docs on RTD. There's no good tool built into mkdocs for this, but https://github.com/linkchecker/linkchecker works quite well here and seems fast enough.
We now have three scripts that can be run in the docs environment:
@stichbury I've fixed/ignored all the errors I found apart from this one, where I can't find an authoritative-looking link to the INCITS guidelines that actually works. Please can you suggest something?
Screenshot
Notice
I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":