mirror of
https://github.com/astral-sh/uv.git
synced 2025-07-07 13:25:00 +00:00
e61a221fef
## 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 
105 lines
3.1 KiB
YAML
105 lines
3.1 KiB
YAML
site_name: uv
|
|
theme:
|
|
name: material
|
|
favicon: assets/favicon.ico
|
|
features:
|
|
- navigation.instant
|
|
- navigation.instant.prefetch
|
|
- navigation.instant.progress
|
|
- navigation.expand
|
|
- navigation.tracking
|
|
- content.code.annotate
|
|
- toc.integrate
|
|
- toc.follow
|
|
- navigation.path
|
|
- 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
|
|
- toc:
|
|
permalink: "#"
|
|
- pymdownx.snippets:
|
|
- pymdownx.magiclink:
|
|
- attr_list:
|
|
- md_in_html:
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- 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
|
|
- typeset
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
extra:
|
|
analytics:
|
|
provider: fathom
|
|
nav:
|
|
- Introduction: index.md
|
|
- Getting started:
|
|
- Installation: installation.md
|
|
- First steps: first-steps.md
|
|
- Guides:
|
|
- Installing Python: guides/install-python.md
|
|
- Running scripts: guides/scripts.md
|
|
- Using tools: guides/tools.md
|
|
- Creating a project: guides/projects.md
|
|
- Concepts:
|
|
- Projects: preview/projects.md
|
|
- Command-line tools: preview/tools.md
|
|
- Python versions: python-versions.md
|
|
- Workspaces: preview/workspaces.md
|
|
- Dependency sources: preview/dependencies.md
|
|
- Resolution: resolution.md
|
|
- Caching: cache.md
|
|
- Authentication: configuration/authentication.md
|
|
- Configuration:
|
|
- Configuration files: configuration/files.md
|
|
- Environment variables: configuration/environment.md
|
|
- Integration guides:
|
|
- Using in Docker: guides/docker.md
|
|
- Using in GitHub Actions: guides/github.md
|
|
- Using in pre-commit: guides/pre-commit.md
|
|
- Low-level operations:
|
|
- Using environments: pip/environments.md
|
|
- Managing packages: pip/packages.md
|
|
- Inspecting packages: pip/inspection.md
|
|
- Declaring dependencies: pip/dependencies.md
|
|
- Locking environments: pip/compile.md
|
|
- Policies:
|
|
- Versioning: versioning.md
|
|
- Platform support: platforms.md
|
|
- Compatibility with pip: pip/compatibility.md
|