forked from astral-sh/uv
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.template.yml
138 lines (138 loc) · 4.34 KB
/
mkdocs.template.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
site_name: uv
theme:
name: material
logo: assets/logo-letter.svg
favicon: assets/favicon.ico
features:
- 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
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/publish.md
- Concepts:
- concepts/index.md
- Projects: concepts/projects.md
- Dependencies: concepts/dependencies.md
- Workspaces: concepts/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
- Integration guides:
- 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
- FastAPI: guides/integration/fastapi.md
- Alternative indexes: guides/integration/alternative-indexes.md
- Dependency bots: guides/integration/dependency-bots.md
- The pip interface:
- pip/index.md
- 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
- Compatibility with pip: pip/compatibility.md
- Reference:
- reference/index.md
- Commands: reference/cli.md
- Settings: reference/settings.md
- Resolver: reference/resolver-internals.md
- Benchmarks: reference/benchmarks.md
- Versioning: reference/versioning.md
- Platform support: reference/platforms.md
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn