Commit Graph

17 Commits

Author SHA1 Message Date
Zanie Blue 44a6dbfa53 Improvements to the documentation (#5718) 2024-08-03 08:41:33 -05:00
konsti 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
Zanie Blue b14945a7b1 Bump version to 0.2.33 (#5712) 2024-08-01 21:39:17 +00:00
Zanie Blue 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
Zanie Blue 8d14a4cb4f Simplify GHA UV_SYSTEM_PYTHON examples (#5659) 2024-07-31 10:49:40 -05:00
Charlie Marsh 38c232e466 Bump version to v0.2.32 (#5641) 2024-07-30 18:56:39 -04:00
Zanie Blue f971631adf Wrap documentation at 100 characters (#5635)
Basically sick of dealing with mixed formatting here. Going with the
number at
https://github.com/astral-sh/uv/blob/7c08e61b73d54bb91130041859dcedc74f7a8e0c/.editorconfig#L20
2024-07-30 22:17:58 +00:00
Charlie Marsh 48162de974 Bump version to v0.2.31 (#5568) 2024-07-29 14:06:20 -04:00
Charlie Marsh 6901a14aa0 Bump version to v0.2.30 (#5486) 2024-07-26 13:36:05 -04:00
Zanie Blue 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
Zanie Blue 35b6726df5 Bump version to 0.2.29 (#5431) 2024-07-24 22:23:34 +00:00
Ahmed Ilyas 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
Zanie Blue 3a85353707 Bump version to 0.2.28 (#5363) 2024-07-23 14:04:55 -05:00
Zanie Blue dac696e950 Bundle of documentation changes (#5307)
Following #5239
2024-07-23 13:29:59 -05:00
Zanie Blue 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
Zanie Blue 833097b93f Bump version to 0.2.27 (#5230) 2024-07-19 22:06:49 +00:00
Zanie Blue 61a81da760 Move integration guide docs and edit Azure integration guide (#5117) 2024-07-18 03:47:32 +00:00