mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-07-07 21:35:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Migrate from MdBook to MkDocs (#5062)

Browse source 
## Summary

We want to have consistency between the Ruff and uv documentation for
the upcoming release. We don't love the Ruff docs, but we'd rather have
consistency and then work towards improving them both, rather than have
two very-different documentation sites that both have weaknesses.

The setup here is simpler than in Ruff as: (1) we don't yet generate any
docs from Rust and (2) we don't try to reuse the README in the uv
documentation (which adds a lot of complexity in Ruff). So the change
here is mostly a 1-to-1 port to MkDocs.

## Test Plan

![Screenshot 2024-07-14 at 9 49
15 PM](https://github.com/user-attachments/assets/8bfb5b06-08ff-4329-b368-d9087b78996e)
This commit is contained in:
Charlie Marsh 2024-07-15 18:22:07 -04:00 • committed by GitHub
parent 35b268a614
commit e61a221fef
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
27 changed files with 548 additions and 200 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/guides/install-python.md
View file

@ -36,7 +36,7 @@ To view available and installed Python versions:
$ uv python list
```
See the [`python list`](../python-versions.html#viewing-available-python-versions) documentation for more details.
See the [`python list`](../python-versions.md#viewing-available-python-versions) documentation for more details.
<!--TODO(zanieb): The above should probably link to a CLI reference and that content should be moved out of that file -->
@ -62,4 +62,4 @@ uv will also use an existing Python installation if already present on the syste
To force uv to use the system Python, provide the `--python-preference only-system` option.
See the [Python version preference](../python-versions.html#adjusting-python-version-preferences) documentation for more details.
See the [Python version preference](../python-versions.md#adjusting-python-version-preferences) documentation for more details.