uv/docs/pip at f8bda467fa6f0154295e4e07809f73749369cb3f - uv

Python/uv

mirror of https://github.com/astral-sh/uv synced 2026-01-21 05:20:09 -05:00

Files

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

compatibility.md

Use prettier to format the documentation (#5708 )

2024-08-02 08:58:31 -05:00

compile.md

Remove some trailing backticks from the docs (#5781 )

2024-08-05 00:56:03 +00:00

dependencies.md

Use prettier to format the documentation (#5708 )

2024-08-02 08:58:31 -05:00

environments.md

docs: use stricter validation options (#6096 )