docs: use stricter validation options #6096
Merged
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
mkniewallner
force-pushed
the
docs/stricter-validation-options
branch
from
50feedb
to
8d61a6b
Compare
zanieb
added
documentation
|
https:/astral-sh/uv/actions/runs/10396684003/job/28791143067 whoops, this broke the main build. That's because |
|
Ah just noticed this broke on my branch. Thanks for noting it too :D We'll need to upgrade insiders, but I recall there were some regressions we were blocked by... |
Ah, too bad! We can remove |
zanieb
added a commit
that referenced
this pull request
Aug 15, 2024
zanieb
pushed a commit
to astral-sh/ruff
that referenced
this pull request
Aug 19, 2024
## Summary Applying the same change as done in astral-sh/uv#6096. Note that in `uv` repository, this [broke the docs build](astral-sh/uv#6096 (comment)) because `anchors` is `mdkocs` 1.6+ only, and insiders used 1.5.0 while public dependencies used 1.6.0, but in this repository, both use 1.6.0 ([public](https:/astral-sh/ruff/blob/049cda2ff37bcae59f7dae9af6a453075c76e635/docs/requirements.txt#L3), [insiders](https:/astral-sh/ruff/blob/049cda2ff37bcae59f7dae9af6a453075c76e635/docs/requirements-insiders.txt#L3)), so this should not be an issue to have in the template. Contrarily to `uv` repository, no violations were reported here, but this could prevent adding some in the future. ## Test Plan Local run of the documentation + `mkdocs build --strict`.
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.
Summary
mkdocssupports validation rules for links, which can be tightened to report more issues than the default configuration. I used the recommended "maximal strictness" configuration from the documentation.Adding the
anchorsrule helped spot 4 errors:Test Plan
Local run of the documentation +
mkdocs build --strict.