-
Notifications
You must be signed in to change notification settings - Fork 955
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: list supported sdist formats #7168
Merged
charliermarsh
merged 6 commits into
astral-sh:main
from
mkniewallner:docs/list-supported-sdist-formats
Sep 7, 2024
Merged
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
3f80bfe
docs: list supported sdist formats
mkniewallner 43aab74
docs(README): fix a wrong link
mkniewallner b4883cd
docs: use `e.g.`
mkniewallner fcf6a94
docs: respect style guide
mkniewallner 23608de
Merge branch 'main' into docs/list-supported-sdist-formats
charliermarsh 2bc8fd9
usually -> typically
charliermarsh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -296,6 +296,18 @@ To ensure reproducibility, messages for unsatisfiable resolutions will not menti | |
distributions were excluded due to the `--exclude-newer` flag — newer distributions will be treated | ||
as if they do not exist. | ||
|
||
## Source distribution | ||
|
||
Most packages publish their source distributions as gzip tarball (`.tar.gz`) or zip (`.zip`) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should clarify that PEP 625 has decided that |
||
archives, but while less common, other formats exist. uv supports the following formats and | ||
extensions when reading and extracting source distributions: | ||
|
||
- bzip2 tarball (`.tar.bz2`) | ||
- gzip tarball (`.tar.gz`) | ||
- xz tarball (`.tar.xz`) | ||
- zip (`.zip`) | ||
- zstd tarball (`.tar.zst`) | ||
|
||
## Learn more | ||
|
||
For more details about the internals of the resolver, see the | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Initially wanted to also add a link to the new section here, but the code generating markdown pages outputs all links with
<a>
HTML tags, which made it not possible to have both a correct link andmkdocs
not complaining about the link not existing in strict mode. Since there are no other links to other internal pages here and insettings.rs
, I assumed that this is simply not yet supported by the code generating markdown pages, so left this out for now.