Skip to content

Add documentation for the zipapp distribution#11459

Merged
pfmoore merged 4 commits intopypa:mainfrom
pfmoore:zipapp_docs
Sep 18, 2022
Merged

Add documentation for the zipapp distribution#11459
pfmoore merged 4 commits intopypa:mainfrom
pfmoore:zipapp_docs

Conversation

@pfmoore
Copy link
Copy Markdown
Member

@pfmoore pfmoore commented Sep 18, 2022

Documents the new zipapp distribution, noting that it is still experimental.

@pfmoore
Copy link
Copy Markdown
Member Author

pfmoore commented Sep 18, 2022

At the moment, this has the zipapp as one subheading under "supported methods". As the zipapp is currently experimental, is this OK? The alternative would be to put it under "Alternative methods", but then that looks a bit odd because the existing text under than heading has no subheading. I tried having it as a heading on the same level as "Supported Methods", but that looked wrong (too prominent).

Does anyone have a preference? Words is hard 🙁

Comment thread docs/html/installation.md Outdated

then the currently active Python interpreter will be used.

```{note}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: put the admonition at the top of the section or after the first paragraph, coz people skim 😅

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lol, good point. Done.

@pfmoore
Copy link
Copy Markdown
Member Author

pfmoore commented Sep 18, 2022

Merging this, we can always revise it later 🙂

@pfmoore pfmoore merged commit fbb7f0b into pypa:main Sep 18, 2022
@pfmoore pfmoore deleted the zipapp_docs branch September 18, 2022 12:16
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants