Add meta titles to documents in guides, excluding integration documents. (#10539)

## Summary
Add meta titles to documents in guides, excluding integration documents.
<!-- What's the purpose of the change? What does it do, and why? -->

## Test Plan
``uvx --with-requirements docs/requirements.txt -- mkdocs build --strict
-f mkdocs.public.yml``
<details>
 <summary>Build Result</summary>

* ``guides/install-python``
```html
...
<meta name="description" content="Guide to install specific Python versions, manage existing installations, and automate downloads with uv.">
...
<title>Install and Manage Python | uv</title>
...
```
* ``guides/projects``
```html
...
<meta name="description" content="Guide to create, manage, and build Python projects with uv, including dependencies and distributions.">
...
<title>Working on projects | uv</title>
...
```
* ``guides/publish``
```html
...
<meta name="description" content="Guide to build and publish Python packages using uv">
...
<title>Publishing a package | uv</title>
...
```
* ``guides/scripts``
```html
...
<meta name="description" content="Run Python scripts quickly and manage dependencies efficiently using uv. Learn about inline metadata and more.">
...
<title>Run Scripts | uv</title>
...
```
* ``guides/tools``
```html
...
<meta name="description" content="Guide to run, install, and upgrade Python tools using uv.">
...
<title>Using tools | uv</title>
...
```
</details>

---------

Co-authored-by: Charles Tapley Hoyt <cthoyt@gmail.com>
Co-authored-by: Zanie Blue <contact@zanie.dev>
This commit is contained in:
FishAlchemist 2025-01-16 04:12:55 +08:00 committed by GitHub
parent 1af02ce8f2
commit 9736868908
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 33 additions and 0 deletions

View File

@ -1,3 +1,10 @@
---
title: Installing and managing Python
description:
A guide to using uv to install Python, including requesting specific versions, automatic
installation, viewing installed versions, and more.
---
# Installing Python # Installing Python
If Python is already installed on your system, uv will If Python is already installed on your system, uv will

View File

@ -1,3 +1,10 @@
---
title: Working on projects
description:
A guide to using uv to create and manage Python projects, including adding dependencies, running
commands, and building publishable distributions.
---
# Working on projects # Working on projects
uv supports managing Python projects, which define their dependencies in a `pyproject.toml` file. uv supports managing Python projects, which define their dependencies in a `pyproject.toml` file.

View File

@ -1,3 +1,8 @@
---
title: Publishing a package
description: A guide to using uv to build and publish Python packages to a package index, like PyPI.
---
# Publishing a package # Publishing a package
uv supports building Python packages into source and binary distributions via `uv build` and uv supports building Python packages into source and binary distributions via `uv build` and

View File

@ -1,3 +1,10 @@
---
title: Running scripts
description:
A guide to using uv to run Python scripts, including support for inline dependency metadata,
reproducible scripts, and more.
---
# Running scripts # Running scripts
A Python script is a file intended for standalone execution, e.g., with `python <script>.py`. Using A Python script is a file intended for standalone execution, e.g., with `python <script>.py`. Using

View File

@ -1,3 +1,10 @@
---
title: Using tools
description:
A guide to using uv to run tools published as Python packages, including one-off invocations with
uvx, requesting specific tool versions, installing tools, upgrading tools, and more.
---
# Using tools # Using tools
Many Python packages provide applications that can be used as tools. uv has specialized support for Many Python packages provide applications that can be used as tools. uv has specialized support for