Skip to content

gh-85454: Remove distutils documentation - #95239

Merged
ambv merged 1 commit into
python:mainfrom
tiran:gh-85454-remove-distutils-docs
Jul 25, 2022
Merged

ambv merged 1 commit into
python:mainfrom
tiran:gh-85454-remove-distutils-docs

Conversation

@tiran

@tiran tiran commented Jul 25, 2022 •

Copy link
Copy Markdown
Member

Most places now refer to setuptools or link to setuptools documentation.
Some examples like zipapp need to be updated later.

Most places now refer to setuptools or link to setuptools documentation.
Some examples like zipapp need to be updated later.
@tiran
tiran requested a review from vsajip as a code owner July 25, 2022 10:48
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news awaiting core review labels Jul 25, 2022
@ambv
ambv merged commit a566912 into python:main Jul 25, 2022
@merwok

merwok commented Jul 25, 2022

Copy link
Copy Markdown
Member

Given the numerous external links pointing to our docs, I was thinking of keeping the documents (without toctree reference) to avoid 404 errors and include a file mentioning the removal and linking to packaging.python.org.

@ambv

ambv commented Jul 25, 2022

Copy link
Copy Markdown
Contributor

@merwok, IDK. https://docs.python.org/3/ currently points at 3.10 and includes the deprecation warning at https://docs.python.org/3/library/distutils.html:

distutils is deprecated with removal planned for Python 3.12. See the What’s New entry for more information.

https://docs.python.org/3/ will link to 3.11 between October 2022 and October 2023. This will include the same deprecation warning on the distutils.html page.

When we remove other deprecations, we remove them from the docs, there is no "Removed in ..." Sphinx directive. Do you feel distutils.html is special somehow?

@ambv

ambv commented Jul 25, 2022

Copy link
Copy Markdown
Contributor

Umm, apparently I'm wrong about "there is no "Removed in ..." Sphinx directive". I thought deprecated-removed was used for future removals but there are two examples where this applies to historical deprecations:

Given this precedent, if you feel we should leave the distutils.html file non-404'ing, I'm happy to add a dummy page to the docs to amend this PR.

@tiran

tiran commented Jul 25, 2022

Copy link
Copy Markdown
Member Author

@merwok has a point. A 401 is not user-friendly. Can we have a redirect rule on docs.python.org to 301 Moved Permanently the library/distutils.html and distutils/index.html to a page that points the user to setuptools.

@tiran
tiran deleted the gh-85454-remove-distutils-docs branch July 25, 2022 16:39
@merwok

merwok commented Jul 25, 2022

Copy link
Copy Markdown
Member

Re-adding 13 doc files with minimal contents would be more straightforward IMO. But if you think it’s cruft for the CPython repo, and it’s ok if someone has to chase the docs infra repo to see or change how redirections are done, then I can make a PR there.

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 skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants