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

gh-85454: Remove distutils documentation #95239

Merged
merged 1 commit into from
Jul 25, 2022

Conversation

tiran
Copy link
Member

@tiran tiran commented Jul 25, 2022

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.
@merwok
Copy link
Member

merwok commented Jul 25, 2022

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
Copy link
Contributor

ambv commented Jul 25, 2022

@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
Copy link
Contributor

ambv commented Jul 25, 2022

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
Copy link
Member Author

tiran commented Jul 25, 2022

@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
Copy link
Member

merwok commented Jul 25, 2022

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