From db0b44b88cd03dff486170853d6f17d4152c78ab Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Fri, 9 Aug 2024 12:31:10 -0500 Subject: [PATCH] Move some documents to relevant sections (#5968) --- docs/{ => getting-started}/features.md | 20 ++++++++++---------- docs/{ => getting-started}/first-steps.md | 2 +- docs/{ => getting-started}/installation.md | 6 +++--- docs/index.md | 8 ++++---- docs/{ => reference}/platforms.md | 0 docs/{ => reference}/versioning.md | 0 mkdocs.template.yml | 10 +++++----- 7 files changed, 23 insertions(+), 23 deletions(-) rename docs/{ => getting-started}/features.md (81%) rename docs/{ => getting-started}/first-steps.md (93%) rename docs/{ => getting-started}/installation.md (94%) rename docs/{ => reference}/platforms.md (100%) rename docs/{ => reference}/versioning.md (100%) diff --git a/docs/features.md b/docs/getting-started/features.md similarity index 81% rename from docs/features.md rename to docs/getting-started/features.md index 02c4f0b3b..86450724e 100644 --- a/docs/features.md +++ b/docs/getting-started/features.md @@ -15,7 +15,7 @@ Installing and managing Python itself. - `uv python pin`: Pin the current project to use a specific 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 @@ -23,7 +23,7 @@ Executing standalone Python scripts, e.g., `example.py`. - `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 @@ -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 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 @@ -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 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 @@ -60,7 +60,7 @@ Creating virtual environments (replacing `venv` and `virtualenv`): - `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 [`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 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)): - `uv pip compile`: Compile requirements into 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 - 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 @@ -100,5 +100,5 @@ self-update: ## Next steps -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. +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. diff --git a/docs/first-steps.md b/docs/getting-started/first-steps.md similarity index 93% rename from docs/first-steps.md rename to docs/getting-started/first-steps.md index 2a7cf6965..d7ead0aba 100644 --- a/docs/first-steps.md +++ b/docs/getting-started/first-steps.md @@ -66,4 +66,4 @@ $ uv pip --version # Can be used with a subcommand ## Next steps 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. diff --git a/docs/installation.md b/docs/getting-started/installation.md similarity index 94% rename from docs/installation.md rename to docs/getting-started/installation.md index df9a65898..101b13541 100644 --- a/docs/installation.md +++ b/docs/getting-started/installation.md @@ -88,7 +88,7 @@ $ brew install uv uv provides a Docker image at [`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 @@ -100,5 +100,5 @@ the standalone installer via `github.com` instead of `astral.sh`. ## Next steps -See the [first steps](./first-steps.md) or jump straight to the [guides](./guides/index.md) to start -using uv. +See the [first steps](./first-steps.md) or jump straight to the [guides](../guides/index.md) to +start using uv. diff --git a/docs/index.md b/docs/index.md index 141c7b017..50fe12eef 100644 --- a/docs/index.md +++ b/docs/index.md @@ -46,12 +46,12 @@ $ curl -LsSf https://astral.sh/uv/install.sh | sh $ 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 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 @@ -203,5 +203,5 @@ See the [pip interface documentation](./pip/index.md) to get started. ## Learn more -See the [first steps](./first-steps.md) or jump straight to the [guides](./guides/index.md) to start -using uv. +See the [first steps](./getting-started/first-steps.md) or jump straight to the +[guides](./guides/index.md) to start using uv. diff --git a/docs/platforms.md b/docs/reference/platforms.md similarity index 100% rename from docs/platforms.md rename to docs/reference/platforms.md diff --git a/docs/versioning.md b/docs/reference/versioning.md similarity index 100% rename from docs/versioning.md rename to docs/reference/versioning.md diff --git a/mkdocs.template.yml b/mkdocs.template.yml index 7167ccd6a..007c5be8a 100644 --- a/mkdocs.template.yml +++ b/mkdocs.template.yml @@ -82,9 +82,9 @@ extra: nav: - Introduction: index.md - Getting started: - - Installation: installation.md - - First steps: first-steps.md - - Features: features.md + - Installation: getting-started/installation.md + - First steps: getting-started/first-steps.md + - Features: getting-started/features.md - Guides: - guides/index.md - Installing Python: guides/install-python.md @@ -124,5 +124,5 @@ nav: - Commands: reference/cli.md - Settings: reference/settings.md - Resolver: reference/resolver-internals.md - - Versioning: versioning.md - - Platform support: platforms.md + - Versioning: reference/versioning.md + - Platform support: reference/platforms.md