db371560bc
Use prettier to format the documentation ( #5708 )
...
To enforce the 100 character line limit in markdown files introduced in
https://github.com/astral-sh/uv/pull/5635 , and to automate the
formatting of markdown files, i've added prettier and formatted our
markdown files with it.
I've excluded the changelog and the generated references documentation
from this for having too many changes, but we can also include them.
I'm not particular on which style we use. My main motivations are
(major) not having to reflow markdown files myself anymore and (minor)
consistence between all markdown files. I've chosen prettier for similar
reason as we chose black, it's a single good style that's automated and
shared in the community. I do prefer prettier's style of not breaking
inside of a link name though.
This PR is in two parts, the first adds prettier to CI and documents
using it, while the second actually formats the docs. When merge
conflicts arise, we can drop the last commit and regenerate it with `npx
prettier --prose-wrap always --write BENCHMARKS.md CONTRIBUTING.md
README.md STYLE.md docs/*.md docs/concepts/**/*.md docs/guides/**/*.md
docs/pip/**/*.md`.
---------
Co-authored-by: Zanie Blue <contact@zanie.dev>
2024-08-02 08:58:31 -05:00
f2c4b9c752
Show default and possible options in CLI reference documentation ( #5720 )
...
## Summary
Closes #5692 .
2024-08-02 12:55:50 +00:00
a6416aa450
Fix CLI reference URLs to subcommands ( #5722 )
...
## Summary
Currently all of these links end up 404-ed. I've added a `#` to fix the
URLs.
<img width="653" alt="Screenshot 2024-08-02 at 12 34 22"
src="https://github.com/user-attachments/assets/9b66adcc-431c-441a-8f4f-1b579472fdce ">
## Test Plan
Checked manually.
2024-08-02 07:35:33 -05:00
ff9f3dede1
Support build constraints ( #5639 )
...
## Summary
Partially resolves #5561 . Haven't added overrides support yet but I can
add it tomorrow if the current approach for constraints is ok.
## Test Plan
`cargo test`
Manually checked trace logs after changing the constraints.
2024-08-02 02:15:58 +00:00
b14945a7b1
Bump version to 0.2.33 ( #5712 )
2024-08-01 21:39:17 +00:00
6797caccdb
Update top-level command descriptions ( #5706 )
...
Addresses feedback in https://github.com/astral-sh/uv/pull/5700
2024-08-01 20:29:26 +00:00
78d4045729
Don't use equals signs for cli args with value ( #5704 )
...
Use a consistent style for cli arguments with a value, e.g.
`--resolution lowest`, not `--resolution=lowest`.
2024-08-01 14:17:30 -05:00
34f657c964
Unhide the experimental top-level commands ( #5700 )
2024-08-01 14:06:07 -05:00
0f30c69624
Move settings reference to reference section ( #5689 )
...
Joining #5685 in a dedicated reference section
2024-08-01 16:20:30 +00:00
f107406727
Generate CLI reference for documentation ( #5685 )
...
Loosely based on [Cargo's
format](https://github.com/rust-lang/cargo/blob/master/src/doc/src/commands/cargo-build.md )
<img width="896" alt="Screenshot 2024-08-01 at 9 44 03 AM"
src="https://github.com/user-attachments/assets/7c016bb3-2b54-46af-8ea8-ce82e07a0e30 ">
Future work includes:
- Grouping options
- Enforcing some sort of specific command ordering
- Showing possible values for enums
- Adding "long_about" to commands for more context
2024-08-01 16:04:16 +00:00
df6106f5bf
Use "uv" for title of index instead of "Introduction" ( #5677 )
...
<img width="807" alt="Screenshot 2024-07-31 at 5 12 48 PM"
src="https://github.com/user-attachments/assets/8a3cc824-c242-4688-a7d9-5b88198a6b94 ">
vs
<img width="807" alt="Screenshot 2024-07-31 at 5 13 21 PM"
src="https://github.com/user-attachments/assets/04f77771-94c3-4d2e-81d2-2db63aa649bd ">
2024-07-31 18:24:55 -05:00
b0e37859ed
Bold active nav links for accessibility ( #5673 )
...
Before
<img width="412" alt="Screenshot 2024-07-31 at 3 47 38 PM"
src="https://github.com/user-attachments/assets/d95ebb62-079b-4e20-964c-9876b5978e4c ">
After
<img width="412" alt="Screenshot 2024-07-31 at 3 47 21 PM"
src="https://github.com/user-attachments/assets/a658d46a-3eeb-4f00-8952-d4c1dd91afe6 ">
2024-07-31 16:16:48 -05:00
ef84380954
Add documentation for caching the uv cache in GHA ( #5663 )
...
Related to https://github.com/astral-sh/uv/issues/5409
2024-07-31 11:38:54 -05:00
8d14a4cb4f
Simplify GHA `UV_SYSTEM_PYTHON` examples ( #5659 )
2024-07-31 10:49:40 -05:00
22d152192d
Improvements to the dependency concept doc ( #5658 )
2024-07-31 15:44:25 +00:00
37a60a57e8
Prompt an early jump to the feature overview during first steps ( #5655 )
...
Addressing some feedback about the first-steps covering the help and
version commands.
I'm not sure what else to do here since the first steps with uv are very
dependent on the features you need.
2024-07-31 10:13:04 -05:00
0c680824ca
Omit the nav bar title when it has no use ( #5316 )
...
Turns out this is needed for navigation on mobile, but useless on larger
screens.
Closes #5130
<img width="1551" alt="Screenshot 2024-07-22 at 5 47 49 PM"
src="https://github.com/user-attachments/assets/2173549e-e65d-4691-be83-5e3bf0191dd5 ">
<img width="1551" alt="Screenshot 2024-07-22 at 5 48 02 PM"
src="https://github.com/user-attachments/assets/81012ba8-ce85-4276-8ffa-5c7ef556c389 ">
<img width="1551" alt="Screenshot 2024-07-22 at 5 48 08 PM"
src="https://github.com/user-attachments/assets/ecf8fcd7-e5d4-45c4-8d46-d09d91a8bbe9 ">
2024-07-31 10:08:22 -05:00
89947681d1
Improve copy of console command examples ( #5397 )
...
## Summary
This PR improves the copy of the console command example by:
- Preventing the selection of generic prompts and generic output
- Lazily setting copy content by leveraging intersection observer
Most of the changes are inspired by
https://github.com/opensafely/documentation/pull/1461
Some other useful refs:
- https://github.com/squidfunk/mkdocs-material/issues/3647
-
https://mkdocstrings.github.io/recipes/#prevent-selection-of-prompts-and-output-in-python-code-blocks
Resolves #5355
## Test Plan
-
``` shell-session
mkdocs serve -f mkdocs.public.yml
```
- Navigate to http://localhost:8000/uv/first-steps/#viewing-the-version
- Try clicking the copy button
- Try copying by selecting the content
---------
Co-authored-by: Zanie Blue <contact@zanie.dev>
2024-07-31 14:52:02 +00:00
0b8b0e0cbe
Drop badges from docs landing ( #5617 )
...
There has been opposition to these, we can have a dedicated community
page instead
2024-07-31 09:36:01 -05:00
fbff1baf33
Improvements to the Python version concepts documentation ( #5638 )
...
Depends on https://github.com/astral-sh/uv/pull/5637
2024-07-31 08:40:50 -05:00
7ef830460e
Replace `--python-preference installed` with `managed` ( #5637 )
...
Collapses the previous default into "managed" and makes the "managed"
behavior match "installed". People should use "only-managed" if they
want that behavior, it seems overly complicated otherwise.
2024-07-31 08:40:39 -05:00
cbb13e6584
Improve the project guide ( #5626 )
2024-07-30 18:26:23 -05:00
38c232e466
Bump version to v0.2.32 ( #5641 )
2024-07-30 18:56:39 -04:00
5d727cb0af
Deprecate the `--isolated` flag ( #5466 )
...
## Summary
This PR deprecates the `--isolated` flag. The treatment varies across
the APIs:
- For non-preview APIs, we warn but treat it as equivalent to
`--no-config`.
- For preview APIs, we warn and ignore it, with two exceptions...
- For `tool run` and `run` specifically, we don't even warn, because we
can't differentiate the command-specific `--isolated` from the global
`--isolated`.
2024-07-30 22:40:38 +00:00
f971631adf
Wrap documentation at 100 characters ( #5635 )
...
Basically sick of dealing with mixed formatting here. Going with the
number at
7c08e61b73/.editorconfig (L20)
2024-07-30 22:17:58 +00:00
b081425a77
Improvements to the project concept docs ( #5634 )
2024-07-30 22:11:52 +00:00
8545ae2312
Rename more use of "lock file" to "lockfile" ( #5629 )
2024-07-30 19:09:43 +00:00
3e7b9fb2ee
Add documentation for cache clearing ( #5517 )
...
See: https://github.com/astral-sh/uv/pull/5391#issuecomment-2248757705
2024-07-30 09:38:04 -05:00
48162de974
Bump version to v0.2.31 ( #5568 )
2024-07-29 14:06:20 -04:00
12e92b7718
Fix typo in projects.md ( #5523 )
2024-07-28 21:05:26 +01:00
6901a14aa0
Bump version to v0.2.30 ( #5486 )
2024-07-26 13:36:05 -04:00
6eb8f85668
Update documentation sections ( #5452 )
...
Reframes "the low-level interface" as "the pip interface"
Adds indexes to all sections
Renames "commercial indexes" to "alternative indexes"
2024-07-25 12:37:22 -05:00
d17b18ee1e
Minor consistency fixes for code blocks ( #5437 )
...
...as well as some typo fixes. I verified the changes manually.
2024-07-25 09:23:22 -05:00
d0919329fd
Make `--reinstall` imply `--refresh` ( #5425 )
...
## Summary
It's hard for me to imagine a scenario in which a user passed
`--reinstall`, but wanted us to keep respecting cached data for a
package. For example, to actually "rebuild and reinstall" an editable
today, you have to pass both `--reinstall` and `--refresh`.
This PR makes `--reinstall` imply `--refresh`, so we always validate
that the cached data is fresh.
Closes https://github.com/astral-sh/uv/issues/5424 .
2024-07-25 09:45:58 -04:00
35b6726df5
Bump version to 0.2.29 ( #5431 )
2024-07-24 22:23:34 +00:00
3581e27cdf
Bundle of docs changes ( #5426 )
2024-07-24 17:10:33 -05:00
ac81036aa9
Use logo in documentation ( #5421 )
...
Before
<img width="728" alt="Screenshot 2024-07-24 at 3 12 28 PM"
src="https://github.com/user-attachments/assets/2ad83857-a2a5-4c33-9fb2-f2580ccb10af ">
After
<img width="728" alt="Screenshot 2024-07-24 at 3 11 07 PM"
src="https://github.com/user-attachments/assets/dd209d37-3761-4b28-8ca9-9bf7546236a8 ">
Alternatively
<img width="728" alt="Screenshot 2024-07-24 at 3 10 45 PM"
src="https://github.com/user-attachments/assets/88f9cc62-71ec-457c-b946-3168502d46c3 ">
2024-07-24 15:45:10 -05:00
b304d66719
Use env variables in Github Actions docs ( #5411 )
...
## Summary
Use [Github
Actions](https://docs.github.com/en/actions/learn-github-actions/variables#defining-environment-variables-for-a-single-workflow )
`env` to define environment variables.
After:
<img width="751" alt="Screenshot 2024-07-24 at 17 24 23"
src="https://github.com/user-attachments/assets/9c7861f0-e95d-4778-96c0-261df539a0bd ">
2024-07-24 14:37:52 -05:00
41b699e7ac
Add warning to `--link-mode=symlink` documentation ( #5387 )
2024-07-23 22:35:56 +00:00
3822a43560
Fix blurring from nav title box shadow ( #5374 )
...
Fixes blur noted in https://github.com/astral-sh/uv/pull/5316 but
doesn't drop the title entirely.
https://github.com/astral-sh/uv/pull/5316 is my preferred design, if the
implementation was cost-free.
<img width="1259" alt="Screenshot 2024-07-23 at 3 53 48 PM"
src="https://github.com/user-attachments/assets/6f9b828b-884f-447d-8508-ba4023152e2f ">
(nothing to see at the rest of the breakpoints >1220)
<img width="1259" alt="Screenshot 2024-07-23 at 3 53 56 PM"
src="https://github.com/user-attachments/assets/b892cd76-cd91-4e78-b8c8-58e16a8b1130 ">
2024-07-23 17:33:57 -05:00
499b035c8e
Increase padding between each nav section ( #5373 )
...
<img width="1259" alt="Screenshot 2024-07-23 at 3 46 45 PM"
src="https://github.com/user-attachments/assets/dae4df4e-cea3-41a2-842c-652b4f9ca014 ">
<img width="1259" alt="Screenshot 2024-07-23 at 3 46 53 PM"
src="https://github.com/user-attachments/assets/b0751c4b-80bb-4344-816c-e23d5e45f0e4 ">
<img width="1259" alt="Screenshot 2024-07-23 at 3 46 57 PM"
src="https://github.com/user-attachments/assets/1cea6223-2757-49a0-9b87-1961f9bbd17b ">
<img width="1259" alt="Screenshot 2024-07-23 at 3 47 10 PM"
src="https://github.com/user-attachments/assets/a41061c6-f198-45ca-91b6-423f46375089 ">
2024-07-23 17:31:12 -05:00
7ddf67a72b
Add PyPy finder ( #5337 )
...
## Summary
This PR adds PyPy finder and adds PyPy to uv managed Python versions.
## Test Plan
```console
$ cargo run -- python install
```
2024-07-23 14:58:04 -05:00
3a85353707
Bump version to 0.2.28 ( #5363 )
2024-07-23 14:04:55 -05:00
dac696e950
Bundle of documentation changes ( #5307 )
...
Following #5239
2024-07-23 13:29:59 -05:00
49ea4a7a91
Reduce spacing between nav items ( #5310 )
...
**Before**
<img width="1475" alt="Screenshot 2024-07-22 at 3 56 46 PM"
src="https://github.com/user-attachments/assets/a9c6b929-0569-45a6-9840-d49d955dd55a ">
--------
**After**
<img width="1475" alt="Screenshot 2024-07-22 at 3 56 38 PM"
src="https://github.com/user-attachments/assets/98c85e03-fe62-4894-99f6-a49293eacf0b ">
2024-07-23 11:50:00 -05:00
6492f1a897
A bundle of documentation changes ( #5239 )
...
I just need to iterate on everything and we're not doing a lot of
reviews anyway.
Closes #5234
Closes #5191
2024-07-22 17:15:11 +00:00
e809bc339b
Correct guide typo ( #5245 )
...
## Summary
Typo correction for the tools guide.
Fixes #5243
2024-07-20 09:10:44 -04:00
833097b93f
Bump version to 0.2.27 ( #5230 )
2024-07-19 22:06:49 +00:00
583a6e57f2
Write tools concept doc ( #5207 )
2024-07-19 14:24:43 -05:00
f2e2825d1b
docs(settings): bunch of fixes and improvements ( #5177 )
...
## Summary
Spotted some issues in the settings documentation, and room for small
improvements by linking to PEPs/RFCs.
Also updating contribution documentation to mention that it's necessary
to enable the virtual environment before running `mkdocs serve`.
## Test Plan
Running documentation locally.
2024-07-19 10:32:21 -04:00
konsti
eth3lbert
Ahmed Ilyas
Zanie Blue
Charlie Marsh
Mark Ture
InSync
Jo
Ian Wilkinson
Mathieu Kniewallner