uv/docs
Zanie Blue dd7da6af5f
Change "toolchain" to "python" (#4735)
Whew this is a lot.

The user-facing changes are:

- `uv toolchain` to `uv python` e.g. `uv python find`, `uv python
install`, ...
- `UV_TOOLCHAIN_DIR` to` UV_PYTHON_INSTALL_DIR`
- `<UV_STATE_DIR>/toolchains` to `<UV_STATE_DIR>/python` (with
[automatic
migration](https://github.com/astral-sh/uv/pull/4735/files#r1663029330))
- User-facing messages no longer refer to toolchains, instead using
"Python", "Python versions" or "Python installations"

The internal changes are:

- `uv-toolchain` crate to `uv-python`
- `Toolchain` no longer referenced in type names
- Dropped unused `SystemPython` type (previously replaced)
- Clarified the type names for "managed Python installations"
- (more little things)
2024-07-03 07:44:29 -05:00
..
configuration Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
guides Restructure documentation sections to focus on new user experience (#4586) 2024-07-02 11:44:45 -05:00
pip Restructure documentation sections to focus on new user experience (#4586) 2024-07-02 11:44:45 -05:00
preview Change "toolchain" to "python" (#4735) 2024-07-03 07:44:29 -05:00
theme Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
.gitignore Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
book.toml Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
cache.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
first-steps.md Change "toolchain" to "python" (#4735) 2024-07-03 07:44:29 -05:00
installation.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
introduction.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
platforms.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
python.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
README.md Add page for contributing to the docs (#4562) 2024-06-27 07:27:58 -05:00
resolution.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
style.css Restructure documentation sections to focus on new user experience (#4586) 2024-07-02 11:44:45 -05:00
SUMMARY.md Restructure documentation sections to focus on new user experience (#4586) 2024-07-02 11:44:45 -05:00
versioning.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00

Documentation

This is the home of the new documentation for uv.

The documentation is a work in progress and not ready for external references.

Contributing

Install mdbook:

cargo install mdbook

To run the documentation locally:

mdbook watch docs --open

The documentation is published to GitHub Pages on merge to main.