Skip to content

Commit

Permalink
docs: add stricter validation options (#12998)
Browse files Browse the repository at this point in the history
## 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`.
  • Loading branch information
mkniewallner authored Aug 19, 2024
1 parent 049cda2 commit df09045
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions mkdocs.template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,8 @@ not_in_nav: |
extra:
analytics:
provider: fathom
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn

0 comments on commit df09045

Please sign in to comment.