GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-85454: Remove distutils documentation by tiran · Pull Request #95239 · python/cpython

Conversation

@tiran

@tiran tiran commented Jul 25, 2022 •
edited by bedevere-bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

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.

  • Issue: Deprecate and remove distutils #85454

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

arhadthedev reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@tiran
pythongh-85454: Remove distutils documentation
a47c299
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
@bedevere-bot bedevere-bot removed the awaiting core review label Jul 25, 2022
@arhadthedev arhadthedev mentioned this pull request Jul 25, 2022
Unbind the documentation from distutils arhadthedev/cpython#9
Closed
2 tasks done
@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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@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?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@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:

  • https://docs.python.org/3/using/cmdline.html
  • https://docs.python.org/3/library/hmac.html

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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk hugovk mentioned this pull request Sep 18, 2023
[doc] replace 'distutils' examples with 'setuptools' #90163
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vsajip vsajip Awaiting requested review from vsajip vsajip is a code owner

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@tiran @merwok @ambv @bedevere-bot
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.