28685633c0
Add an `llms.txt` to uv ( #13929 )
...
## Summary
The generated file looks like:
```
# uv
> uv is an extremely fast Python package and project manager, written in Rust.
You can use uv to install Python dependencies, run scripts, manage virtual environments,
build and publish packages, and even install Python itself. uv is capable of replacing
`pip`, `pip-tools`, `pipx`, `poetry`, `pyenv`, `twine`, `virtualenv`, and more.
uv includes both a pip-compatible CLI (prepend `uv` to a pip command, e.g., `uv pip install ruff`)
and a first-class project interface (e.g., `uv add ruff`) complete with lockfiles and
workspace support.
## Getting started
- [Features](https://docs.astral.sh/uv/getting-started/features/index.md )
- [First steps](https://docs.astral.sh/uv/getting-started/first-steps/index.md )
- [Installation](https://docs.astral.sh/uv/getting-started/installation/index.md )
## Guides
- [Installing Python](https://docs.astral.sh/uv/guides/install-python/index.md )
- [Publishing packages](https://docs.astral.sh/uv/guides/package/index.md )
- [Working on projects](https://docs.astral.sh/uv/guides/projects/index.md )
- [Running scripts](https://docs.astral.sh/uv/guides/scripts/index.md )
- [Using tools](https://docs.astral.sh/uv/guides/tools/index.md )
## Integrations
- [Alternative indexes](https://docs.astral.sh/uv/guides/integration/alternative-indexes/index.md )
- [AWS Lambda](https://docs.astral.sh/uv/guides/integration/aws-lambda/index.md )
- [Dependency bots](https://docs.astral.sh/uv/guides/integration/dependency-bots/index.md )
- [Docker](https://docs.astral.sh/uv/guides/integration/docker/index.md )
- [FastAPI](https://docs.astral.sh/uv/guides/integration/fastapi/index.md )
- [GitHub Actions](https://docs.astral.sh/uv/guides/integration/github/index.md )
- [GitLab CI/CD](https://docs.astral.sh/uv/guides/integration/gitlab/index.md )
- [Jupyter](https://docs.astral.sh/uv/guides/integration/jupyter/index.md )
- [marimo](https://docs.astral.sh/uv/guides/integration/marimo/index.md )
- [Pre-commit](https://docs.astral.sh/uv/guides/integration/pre-commit/index.md )
- [PyTorch](https://docs.astral.sh/uv/guides/integration/pytorch/index.md )
## Projects
- [Building distributions](https://docs.astral.sh/uv/concepts/projects/build/index.md )
- [Configuring projects](https://docs.astral.sh/uv/concepts/projects/config/index.md )
- [Managing dependencies](https://docs.astral.sh/uv/concepts/projects/dependencies/index.md )
- [Creating projects](https://docs.astral.sh/uv/concepts/projects/init/index.md )
- [Structure and files](https://docs.astral.sh/uv/concepts/projects/layout/index.md )
- [Running commands](https://docs.astral.sh/uv/concepts/projects/run/index.md )
- [Locking and syncing](https://docs.astral.sh/uv/concepts/projects/sync/index.md )
- [Using workspaces](https://docs.astral.sh/uv/concepts/projects/workspaces/index.md )
## Features
- [Authentication](https://docs.astral.sh/uv/concepts/authentication/index.md )
- [Build backend](https://docs.astral.sh/uv/concepts/build-backend/index.md )
- [Caching](https://docs.astral.sh/uv/concepts/cache/index.md )
- [Configuration files](https://docs.astral.sh/uv/concepts/configuration-files/index.md )
- [Package indexes](https://docs.astral.sh/uv/concepts/indexes/index.md )
- [Python versions](https://docs.astral.sh/uv/concepts/python-versions/index.md )
- [Resolution](https://docs.astral.sh/uv/concepts/resolution/index.md )
- [Tools](https://docs.astral.sh/uv/concepts/tools/index.md )
## The pip interface
- [Compatibility with pip](https://docs.astral.sh/uv/pip/compatibility/index.md )
- [Locking environments](https://docs.astral.sh/uv/pip/compile/index.md )
- [Declaring dependencies](https://docs.astral.sh/uv/pip/dependencies/index.md )
- [Using environments](https://docs.astral.sh/uv/pip/environments/index.md )
- [Inspecting environments](https://docs.astral.sh/uv/pip/inspection/index.md )
- [Managing packages](https://docs.astral.sh/uv/pip/packages/index.md )
## Reference
- [Commands](https://docs.astral.sh/uv/reference/cli/index.md )
- [Environment variables](https://docs.astral.sh/uv/reference/environment/index.md )
- [Installer](https://docs.astral.sh/uv/reference/installer/index.md )
- [Settings](https://docs.astral.sh/uv/reference/settings/index.md )
```
Closes #13901 .
2025-06-10 07:46:49 -04:00
1f963d1b89
Move content from the `mkdocs.public.yml` into the template ( #11246 )
...
Closes https://github.com/astral-sh/uv/issues/11242
2025-02-05 16:13:46 +00:00
ca9aaf1c48
Reorganize the project concept documentation ( #9121 )
...
- Adds a collapsible section for the project concept
- Splits the project concept document into several child documents.
- Moves the workspace and dependencies documents to under the project
section
- Adds a mkdocs plugin for redirects, so links to the moved documents
still work
I attempted to make the minimum required changes to the contents of the
documents here. There is a lot of room for improvement on the content of
each new child document. For review purposes, I want to do that work
separately. I'd prefer if the review focused on this structure and idea
rather than the content of the files.
I expect to do this to other documentation pages that would otherwise be
very nested.
The project concept landing page and nav (collapsed by default) looks
like this now:
<img width="1507" alt="Screenshot 2024-11-14 at 11 28 45 AM"
src="https://github.com/user-attachments/assets/88288b09-8463-49d4-84ba-ee27144b62a5 ">
2024-11-19 13:52:12 -06:00
ca85767aff
Reference the root requirements from the insiders requirements file ( #5105 )
...
Seems best not to duplicate these
2024-07-16 09:51:16 -05:00
e61a221fef
Migrate from MdBook to MkDocs ( #5062 )
...
## 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
2024-07-15 22:22:07 +00:00
Charlie Marsh
Zanie Blue