Skip to content
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

Drop the "Distributing Python Modules" section of the docs #107987

Closed
brettcannon opened this issue Aug 15, 2023 · 5 comments
Closed

Drop the "Distributing Python Modules" section of the docs #107987

brettcannon opened this issue Aug 15, 2023 · 5 comments
Labels
docs Documentation in the Doc dir

Comments

@brettcannon
Copy link
Member

brettcannon commented Aug 15, 2023

Documentation

https://docs.python.org/3/distributing/index.html is woefully outdated and the packaging ecosystem is managed externally to the core dev team. It would probably be better to have a link pointing at packaging.python.org than it is to try and maintain this part of the docs.

Linked PRs

@brettcannon brettcannon added the docs Documentation in the Doc dir label Aug 15, 2023
@BrenBarn
Copy link

Does the same apply to the section on installing?

@brettcannon
Copy link
Member Author

Does the same apply to the section on installing?

I don't think so. That page is still relatively accurate for how most people will do things and with what Python typically ships with.

@BrenBarn
Copy link

BrenBarn commented Aug 16, 2023

Does the same apply to the section on installing?

I don't think so. That page is still relatively accurate for how most people will do things and with what Python typically ships with.

Well, yes, for the moment. :-) But it looks to me like it's still mostly documenting how to use pip, right? And pip isn't in the stdlib. So might it be prudent to keep it under packaging docs so that it will remain accurate? (For instance, even the --user part there may now be in danger of getting stale/confusing since the introduction of externally-managed environments.)

Basically it just seems like a good idea to me to not have documentation on how to do packaging that isn't part of the same workflow/control mechanism as the packing tools which are being documented. If the CPython core team has outsourced packaging development to PyPA, then it seems safer to outsource packaging documentation as well and not leave vestiges behind that may get out of sync.

@brettcannon
Copy link
Member Author

But it looks to me like it's still mostly documenting how to use pip, right? And pip isn't in the stdlib.

Pip is effectively shipped with Python (Debian withstanding), so it's as close as one can get to being included with Python short of being in the stdlib.

If you would like to propose removing the installation docs then please open a separate issue for that idea.

miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 17, 2023
…GH-108016)

(cherry picked from commit 33e6e3f)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Yhg1s pushed a commit that referenced this issue Aug 17, 2023
…8016) (#108081)

GH-107987: Remove the Distributing Python Modules guide (GH-108016)
(cherry picked from commit 33e6e3f)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
AA-Turner added a commit to AA-Turner/cpython that referenced this issue Aug 17, 2023
…ythonGH-108016).

(cherry picked from commit 33e6e3f)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
hugovk pushed a commit that referenced this issue Aug 18, 2023
…8016) (#108091)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@hugovk
Copy link
Member

hugovk commented Aug 18, 2023

Thanks @AA-Turner for the PRs!

@hugovk hugovk closed this as completed Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

4 participants
@brettcannon @hugovk @BrenBarn and others