Skip to content

Commit 960714d

Browse files
authored
Tweak some documentation headings (#15556)
Just some nits I want to make incremental progress on
1 parent 9b1328a commit 960714d

File tree

8 files changed

+18
-9
lines changed

8 files changed

+18
-9
lines changed

docs/concepts/projects/config.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,6 @@ with the default build system.
120120
or install it with `uv pip`, uv will attempt to build and install it regardless of the presence
121121
of a `[build-system]` table.
122122

123-
### Build system options
124-
125123
Build systems are used to power the following features:
126124

127125
- Including or excluding files from distributions

docs/concepts/projects/dependencies.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,17 @@ $ uv add "httpx>9999"
7878
we can conclude that your project's requirements are unsatisfiable.
7979
```
8080

81-
### Importing dependencies
81+
### Importing dependencies from requirements files
8282

8383
Dependencies declared in a `requirements.txt` file can be added to the project with the `-r` option:
8484

8585
```
8686
uv add -r requirements.txt
8787
```
8888

89+
See the [pip migration guide](../../guides/migration/pip-to-project.md#importing-requirements-files)
90+
for more details.
91+
8992
## Removing dependencies
9093

9194
To remove a dependency:

docs/concepts/projects/layout.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ explicitly updated using `uv lock`.
8282
`uv.lock` is a human-readable TOML file but is managed by uv and should not be edited manually. The
8383
`uv.lock` format is specific to uv and not usable by other tools.
8484

85-
### `pylock.toml`
85+
### Relationship to `pylock.toml`
8686

8787
In [PEP 751](https://peps.python.org/pep-0751/), Python standardized a new resolution file format,
8888
`pylock.toml`.

docs/concepts/projects/run.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ print([(k, v["title"]) for k, v in data.items()][:10])
6464
The invocation `uv run example.py` would run _isolated_ from the project with only the given
6565
dependencies listed.
6666

67-
## Legacy Windows Scripts
67+
## Legacy scripts on Windows
6868

6969
Support is provided for
7070
[legacy setuptools scripts](https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#scripts).

docs/concepts/projects/sync.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ option:
3232
$ uv run --no-sync ...
3333
```
3434

35-
## Checking if the lockfile is up-to-date
35+
## Checking the lockfile
3636

3737
When considering if the lockfile is up-to-date, uv will check if it matches the project metadata.
3838
For example, if you add a dependency to your `pyproject.toml`, the lockfile will be considered

docs/concepts/resolution.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ bounds on `requires-python` often leads to formally correct but practically inco
139139
as, e.g., resolvers will backtrack to the first published version that omits the upper bound (see:
140140
[`Requires-Python` upper limits](https://discuss.python.org/t/requires-python-upper-limits/12663)).
141141

142-
### Limited resolution environments
142+
## Limited resolution environments
143143

144144
By default, the universal resolver attempts to solve for all platforms and Python versions.
145145

@@ -172,7 +172,7 @@ Entries in the `environments` setting must be disjoint (i.e., they must not over
172172
`sys_platform == 'darwin'` and `python_version >= '3.9'` are not, since both could be true at the
173173
same time.
174174

175-
### Required environments
175+
## Required environments
176176

177177
In the Python ecosystem, packages can be published as source distributions, built distributions
178178
(wheels), or both; but to install a package, a built distribution is required. If a package lacks a

docs/js/extra.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,14 @@ document$.subscribe(function () {
8080
"concepts/projects/config/#build-isolation",
8181
"concepts/projects/dependencies/#dependency-specifiers-pep-508":
8282
"concepts/projects/dependencies/#dependency-specifiers",
83+
"concepts/projects/dependencies/#importing-dependencies":
84+
"concepts/projects/dependencies/#importing-dependencies-from-requirements-files",
85+
"concepts/projects/layout/#pylock-toml":
86+
"concepts/projects/layout/#relationship-to-pylock-toml",
87+
"concepts/projects/run/#legacy-windows-scripts":
88+
"concepts/projects/run/#legacy-scripts-on-windows",
89+
"concepts/projects/sync/#checking-if-the-lockfile-is-up-to-date":
90+
"concepts/projects/sync/#checking-the-lockfile",
8391
};
8492

8593
// The prefix for the site, see `site_dir` in `mkdocs.yml`

mkdocs.template.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ nav:
228228
- Commands: reference/cli.md
229229
- Settings: reference/settings.md
230230
- Environment variables: reference/environment.md
231-
- Installer: reference/installer.md
231+
- Installer options: reference/installer.md
232232
- Troubleshooting:
233233
- reference/troubleshooting/index.md
234234
- Build failures: reference/troubleshooting/build-failures.md

0 commit comments

Comments
 (0)