-
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] Make build actually strict #535
Conversation
for more information, see https://pre-commit.ci
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.
lgtm!
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.
I just looked at the new warnings. It shouldn't be too strict, and we should fix them. They also made it clear that there are a couple of broken links because of renamings of titles 😅
Maybe @stichbury can help you with this?
Sure, happy to fix these in the next sprint, just stick me on the ticket and I'll pick it up w/c 24th June. |
@stichbury - I hope you don't mind I took this over! I actually just wanted to check in this PR whether I've introduced any new broken anchor links with the recent PRs I've just merged. And it turned out that I did add some broken anchor links again 😅 It's very good that we have the strict check in place now! When I started to fix them, I just fixed all of them 😄 We also plan to do the release on Monday, so probably better to have the docs fixed until then 👍 Feel free to review the changes though 🙏 |
Of course not, and thank you 🌟 that's a big help and timesaver for me. |
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 great. Always good to be strict 🎓
Description
We run
mkdocs build
with--strict
in order to catch errors like broken links, but this isn't doing anything because by default the messages are raised with level iNFO and not the required WARNING that would then be elevated to ERROR by--strict
. See https://www.mkdocs.org/user-guide/configuration/#validation for explanation of these options.mkdocs serve
is just for development purposes so shouldn't fail with warnings, hence I removed--strict
there.Linkchecker still works as before, which is an external tool outside mkdocs and checks the built documentation by following external links. Since we now ignore links to our RTD docs themselves (see #524) it is essential we make our checks stricter so that we don't miss broken internal links within our own docs.
Changes to fix warnings include:
.md
extensionNotice
I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":