uv/docs
Mathieu Kniewallner 85be33d719
docs: use stricter validation options (#6096)
## Summary

`mkdocs` supports [validation rules for
links](https://www.mkdocs.org/user-guide/configuration/#validation),
which can be tightened to report more issues than the default
configuration. I used the recommended "maximal strictness" configuration
from the documentation.

Adding the `anchors` rule helped spot 4 errors:
```console
WARNING -  Doc file 'guides/install-python.md' contains a link '../concepts/python-versions.md#python-distributions', but the doc 'concepts/python-versions.md' does not contain an anchor '#python-distributions'.
WARNING -  Doc file 'guides/install-python.md' contains a link '../concepts/python-versions.md#discovery-order', but the doc 'concepts/python-versions.md' does not contain an anchor '#discovery-order'.
WARNING -  Doc file 'guides/projects.md' contains a link '../concepts/projects.md#lock-file', but the doc 'concepts/projects.md' does not contain an anchor '#lock-file'.
WARNING -  Doc file 'pip/environments.md' contains a link '../concepts/python-versions.md#discovery-order', but the doc 'concepts/python-versions.md' does not contain an anchor '#discovery-order'.
```

## Test Plan

Local run of the documentation + `mkdocs build --strict`.
2024-08-14 19:27:22 -05:00
..
.overrides/partials/integrations/analytics Migrate from MdBook to MkDocs (#5062) 2024-07-15 22:22:07 +00:00
assets Use logo in documentation (#5421) 2024-07-24 15:45:10 -05:00
concepts Fix some outdated documentation discussing Python environments (#6058) 2024-08-13 11:47:39 -05:00
configuration Search beyond workspace root when discovering configuration (#5931) 2024-08-08 17:05:02 -04:00
getting-started Move help documentation into dedicated page (#6057) 2024-08-13 11:09:32 -05:00
guides docs: use stricter validation options (#6096) 2024-08-14 19:27:22 -05:00
js Improve copy of console command examples (#5397) 2024-07-31 14:52:02 +00:00
pip docs: use stricter validation options (#6096) 2024-08-14 19:27:22 -05:00
reference Hide python options in `uv tool list` help (#6003) 2024-08-13 11:21:44 -05:00
stylesheets Generate CLI reference for documentation (#5685) 2024-08-01 16:04:16 +00:00
.gitignore Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
index.md Move some documents to relevant sections (#5968) 2024-08-09 17:31:10 +00:00
requirements-insiders.in Reference the root requirements from the insiders requirements file (#5105) 2024-07-16 09:51:16 -05:00
requirements-insiders.txt Reference the root requirements from the insiders requirements file (#5105) 2024-07-16 09:51:16 -05:00
requirements.in Migrate from MdBook to MkDocs (#5062) 2024-07-15 22:22:07 +00:00
requirements.txt Migrate from MdBook to MkDocs (#5062) 2024-07-15 22:22:07 +00:00