Move some documents to relevant sections (#5968)

This commit is contained in:
Zanie Blue 2024-08-09 12:31:10 -05:00 committed by GitHub
parent 3228fc5f35
commit db0b44b88c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 23 additions and 23 deletions

View file

@ -15,7 +15,7 @@ Installing and managing Python itself.
- `uv python pin`: Pin the current project to use a specific Python version. - `uv python pin`: Pin the current project to use a specific Python version.
- `uv python uninstall`: Uninstall a Python version. - `uv python uninstall`: Uninstall a Python version.
See the [guide on installing Python](./guides/install-python.md) to get started. See the [guide on installing Python](../guides/install-python.md) to get started.
## Scripts ## Scripts
@ -23,7 +23,7 @@ Executing standalone Python scripts, e.g., `example.py`.
- `uv run`: Run a script. - `uv run`: Run a script.
See the [guide on running scripts](./guides/scripts.md) to get started. See the [guide on running scripts](../guides/scripts.md) to get started.
## Projects ## Projects
@ -37,7 +37,7 @@ Creating and working on Python projects, i.e., with a `pyproject.toml`.
- `uv run`: Run a command in the project environment. - `uv run`: Run a command in the project environment.
- `uv tree`: View the dependency tree for the project. - `uv tree`: View the dependency tree for the project.
See the [guide on projects](./guides/projects.md) to get started. See the [guide on projects](../guides/projects.md) to get started.
## Tools ## Tools
@ -49,7 +49,7 @@ Running and installing tools published to Python package indexes, e.g., `ruff` o
- `uv tool list`: List installed tools. - `uv tool list`: List installed tools.
- `uv tool update-shell`: Update the shell to include tool executables. - `uv tool update-shell`: Update the shell to include tool executables.
See the [guide on tools](./guides/tools.md) to get started. See the [guide on tools](../guides/tools.md) to get started.
## The pip interface ## The pip interface
@ -60,7 +60,7 @@ Creating virtual environments (replacing `venv` and `virtualenv`):
- `uv venv`: Create a new virtual environment. - `uv venv`: Create a new virtual environment.
See the documentation on [using environments](./pip/environments.md) for details. See the documentation on [using environments](../pip/environments.md) for details.
Managing packages in an environment (replacing [`pip`](https://github.com/pypa/pip) and Managing packages in an environment (replacing [`pip`](https://github.com/pypa/pip) and
[`pipdeptree`](https://github.com/tox-dev/pipdeptree)): [`pipdeptree`](https://github.com/tox-dev/pipdeptree)):
@ -73,18 +73,18 @@ Managing packages in an environment (replacing [`pip`](https://github.com/pypa/p
- `uv pip uninstall`: Uninstall packages. - `uv pip uninstall`: Uninstall packages.
- `uv pip tree`: View the dependency tree for the environment. - `uv pip tree`: View the dependency tree for the environment.
See the documentation on [managing packages](./pip/packages.md) for details. See the documentation on [managing packages](../pip/packages.md) for details.
Locking packages in an environment (replacing [`pip-tools`](https://github.com/jazzband/pip-tools)): Locking packages in an environment (replacing [`pip-tools`](https://github.com/jazzband/pip-tools)):
- `uv pip compile`: Compile requirements into a lockfile. - `uv pip compile`: Compile requirements into a lockfile.
- `uv pip sync`: Sync an environment with a lockfile. - `uv pip sync`: Sync an environment with a lockfile.
See the documentation on [locking environments](./pip/compile.md) for details. See the documentation on [locking environments](../pip/compile.md) for details.
!!! important !!! important
These commands do not exactly implement the interfaces and behavior of the tools they are based on. The further you stray from common workflows, the more likely you are to encounter differences. Consult the [pip-compatibility guide](./pip/compatibility.md) for details. These commands do not exactly implement the interfaces and behavior of the tools they are based on. The further you stray from common workflows, the more likely you are to encounter differences. Consult the [pip-compatibility guide](../pip/compatibility.md) for details.
## Utility ## Utility
@ -100,5 +100,5 @@ self-update:
## Next steps ## Next steps
Read the [guides](./guides/index.md) for an introduction to each feature or check out Read the [guides](../guides/index.md) for an introduction to each feature or check out
[concept](./concepts/index.md) pages for in-depth details about uv's features. [concept](../concepts/index.md) pages for in-depth details about uv's features.

View file

@ -66,4 +66,4 @@ $ uv pip --version # Can be used with a subcommand
## Next steps ## Next steps
Now that you've confirmed uv is installed and know how to get help, check out an Now that you've confirmed uv is installed and know how to get help, check out an
[overview of features](./features.md) or jump to the [guides](./guides/index.md) to start using uv. [overview of features](./features.md) or jump to the [guides](../guides/index.md) to start using uv.

View file

@ -88,7 +88,7 @@ $ brew install uv
uv provides a Docker image at uv provides a Docker image at
[`ghcr.io/astral-sh/uv`](https://github.com/astral-sh/uv/pkgs/container/uv). [`ghcr.io/astral-sh/uv`](https://github.com/astral-sh/uv/pkgs/container/uv).
See our guide on [using uv in Docker](./guides/integration/docker.md) for more details. See our guide on [using uv in Docker](../guides/integration/docker.md) for more details.
## GitHub Releases ## GitHub Releases
@ -100,5 +100,5 @@ the standalone installer via `github.com` instead of `astral.sh`.
## Next steps ## Next steps
See the [first steps](./first-steps.md) or jump straight to the [guides](./guides/index.md) to start See the [first steps](./first-steps.md) or jump straight to the [guides](../guides/index.md) to
using uv. start using uv.

View file

@ -46,12 +46,12 @@ $ curl -LsSf https://astral.sh/uv/install.sh | sh
$ powershell -c "irm https://astral.sh/uv/install.ps1 | iex" $ powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
``` ```
Then, check out the [first steps](./first-steps.md) or read on for a brief overview. Then, check out the [first steps](./getting-started/first-steps.md) or read on for a brief overview.
!!! tip !!! tip
uv may also be installed with pip, Homebrew, and more. See all of the methods on the uv may also be installed with pip, Homebrew, and more. See all of the methods on the
[installation page](./installation.md). [installation page](./getting-started/installation.md).
## Project management ## Project management
@ -203,5 +203,5 @@ See the [pip interface documentation](./pip/index.md) to get started.
## Learn more ## Learn more
See the [first steps](./first-steps.md) or jump straight to the [guides](./guides/index.md) to start See the [first steps](./getting-started/first-steps.md) or jump straight to the
using uv. [guides](./guides/index.md) to start using uv.

View file

@ -82,9 +82,9 @@ extra:
nav: nav:
- Introduction: index.md - Introduction: index.md
- Getting started: - Getting started:
- Installation: installation.md - Installation: getting-started/installation.md
- First steps: first-steps.md - First steps: getting-started/first-steps.md
- Features: features.md - Features: getting-started/features.md
- Guides: - Guides:
- guides/index.md - guides/index.md
- Installing Python: guides/install-python.md - Installing Python: guides/install-python.md
@ -124,5 +124,5 @@ nav:
- Commands: reference/cli.md - Commands: reference/cli.md
- Settings: reference/settings.md - Settings: reference/settings.md
- Resolver: reference/resolver-internals.md - Resolver: reference/resolver-internals.md
- Versioning: versioning.md - Versioning: reference/versioning.md
- Platform support: platforms.md - Platform support: reference/platforms.md