mirror of
https://github.com/astral-sh/uv
synced 2026-01-22 05:50:25 -05:00
5386701cc1
Add configuration documentation for the build backend and make it the preview default. The build backend should generally work with default configuration unless you want specific features such as flat layout or module renaming, there is only a dedicated configuration, but no concept or guide page for the build backend. Once the build backend is stable, we can update the guide documentation to explain that uv defaults to its own build backend, but other build backends are also supported. The uv build backend becomes the default in preview, giving it more exposure from users and preparing it to make it the default proper. The current documentation retains warnings that the build backend is in preview. To see current uses of `uv_build` on GitHub: https://github.com/search?q=path%3A**%2Fpyproject.toml+uv_build%3E%3D0&type=code --------- Co-authored-by: Zanie Blue <contact@zanie.dev>
171 lines
6.1 KiB
YAML
171 lines
6.1 KiB
YAML
site_name: uv
|
|
theme:
|
|
name: material
|
|
logo: assets/logo-letter.svg
|
|
favicon: assets/favicon.ico
|
|
features:
|
|
- navigation.path
|
|
- navigation.instant
|
|
- navigation.instant.prefetch
|
|
- navigation.instant.progress
|
|
- navigation.sections
|
|
- navigation.indexes
|
|
- navigation.tracking
|
|
- content.code.annotate
|
|
- toc.follow
|
|
- navigation.footer
|
|
- navigation.top
|
|
- content.code.copy
|
|
- content.tabs.link
|
|
palette:
|
|
# Note: Using the system theme works with the insiders version
|
|
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#automatic-light-dark-mode
|
|
- media: "(prefers-color-scheme)"
|
|
toggle:
|
|
icon: material/brightness-auto
|
|
name: Switch to light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: astral-light
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: astral-dark
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to system preference
|
|
custom_dir: docs/.overrides
|
|
repo_url: https://github.com/astral-sh/uv
|
|
repo_name: uv
|
|
site_author: charliermarsh
|
|
site_url: https://docs.astral.sh/uv/
|
|
site_dir: site/uv
|
|
markdown_extensions:
|
|
- admonition
|
|
- pymdownx.details
|
|
- pymdownx.snippets:
|
|
- pymdownx.magiclink:
|
|
- attr_list:
|
|
- toc:
|
|
anchorlink: true
|
|
anchorlink_class: "toclink"
|
|
- md_in_html:
|
|
- pymdownx.inlinehilite:
|
|
- pymdownx.superfences:
|
|
- markdown.extensions.attr_list:
|
|
- pymdownx.keys:
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
plugins:
|
|
- search
|
|
- git-revision-date-localized:
|
|
timezone: UTC # It can only be in UTC unless the ISO time can include timezone.
|
|
- redirects:
|
|
# Note that redirecting an anchor, e.g., `concepts/projects/#managing-dependencies` must be done
|
|
# client-side and is implemented in `extra.js` instead.
|
|
redirect_maps:
|
|
"guides/publish.md": "guides/package.md"
|
|
"concepts/workspaces.md": "concepts/projects/workspaces.md"
|
|
"concepts/dependencies.md": "concepts/projects/dependencies.md"
|
|
"reference/versioning.md": "reference/policies/versioning.md"
|
|
"reference/platforms.md": "reference/policies/platforms.md"
|
|
"reference/build_failures.md": "reference/troubleshooting/build-failures.md"
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
extra_javascript:
|
|
- js/extra.js
|
|
extra:
|
|
analytics:
|
|
provider: fathom
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/astral-sh/uv
|
|
- icon: fontawesome/brands/discord
|
|
link: https://discord.com/invite/astral-sh
|
|
- icon: fontawesome/brands/python
|
|
link: https://pypi.org/project/uv/
|
|
- icon: fontawesome/brands/x-twitter
|
|
link: https://x.com/astral_sh
|
|
nav:
|
|
- Introduction: index.md
|
|
- Getting started:
|
|
- getting-started/index.md
|
|
- Installation: getting-started/installation.md
|
|
- First steps: getting-started/first-steps.md
|
|
- Features: getting-started/features.md
|
|
- Getting help: getting-started/help.md
|
|
- Guides:
|
|
- guides/index.md
|
|
- Installing Python: guides/install-python.md
|
|
- Running scripts: guides/scripts.md
|
|
- Using tools: guides/tools.md
|
|
- Working on projects: guides/projects.md
|
|
- Publishing packages: guides/package.md
|
|
- Integrations:
|
|
- guides/integration/index.md
|
|
- Docker: guides/integration/docker.md
|
|
- Jupyter: guides/integration/jupyter.md
|
|
- GitHub Actions: guides/integration/github.md
|
|
- GitLab CI/CD: guides/integration/gitlab.md
|
|
- Pre-commit: guides/integration/pre-commit.md
|
|
- PyTorch: guides/integration/pytorch.md
|
|
- FastAPI: guides/integration/fastapi.md
|
|
- Alternative indexes: guides/integration/alternative-indexes.md
|
|
- Dependency bots: guides/integration/dependency-bots.md
|
|
- AWS Lambda: guides/integration/aws-lambda.md
|
|
- Concepts:
|
|
- concepts/index.md
|
|
- Projects:
|
|
- concepts/projects/index.md
|
|
- Structure and files: concepts/projects/layout.md
|
|
- Creating projects: concepts/projects/init.md
|
|
- Managing dependencies: concepts/projects/dependencies.md
|
|
- Running commands: concepts/projects/run.md
|
|
- Locking and syncing: concepts/projects/sync.md
|
|
- Configuring projects: concepts/projects/config.md
|
|
- Building distributions: concepts/projects/build.md
|
|
- Using workspaces: concepts/projects/workspaces.md
|
|
- Tools: concepts/tools.md
|
|
- Python versions: concepts/python-versions.md
|
|
- Resolution: concepts/resolution.md
|
|
- Caching: concepts/cache.md
|
|
- Configuration:
|
|
- configuration/index.md
|
|
- Configuration files: configuration/files.md
|
|
- Environment variables: configuration/environment.md
|
|
- Authentication: configuration/authentication.md
|
|
- Package indexes: configuration/indexes.md
|
|
- Installer: configuration/installer.md
|
|
- Build backend: configuration/build-backend.md
|
|
- The pip interface:
|
|
- pip/index.md
|
|
- Using environments: pip/environments.md
|
|
- Managing packages: pip/packages.md
|
|
- Inspecting environments: pip/inspection.md
|
|
- Declaring dependencies: pip/dependencies.md
|
|
- Locking environments: pip/compile.md
|
|
- Compatibility with pip: pip/compatibility.md
|
|
- Reference:
|
|
- reference/index.md
|
|
- Commands: reference/cli.md
|
|
- Settings: reference/settings.md
|
|
- Troubleshooting:
|
|
- reference/troubleshooting/index.md
|
|
- Build failures: reference/troubleshooting/build-failures.md
|
|
- Reproducible examples: reference/troubleshooting/reproducible-examples.md
|
|
- Resolver: reference/resolver-internals.md
|
|
- Benchmarks: reference/benchmarks.md
|
|
- Policies:
|
|
- reference/policies/index.md
|
|
- Versioning: reference/policies/versioning.md
|
|
- Platform support: reference/policies/platforms.md
|
|
- License: reference/policies/license.md
|
|
validation:
|
|
omitted_files: warn
|
|
absolute_links: warn
|
|
unrecognized_links: warn
|