docs: remove Python 3.11 intersphinx workaround for distutils refs#5225
Closed
Giggitycountless wants to merge 1 commit into
Closed
docs: remove Python 3.11 intersphinx workaround for distutils refs#5225Giggitycountless wants to merge 1 commit into
Giggitycountless wants to merge 1 commit into
Conversation
PR pypa#4078 pinned the intersphinx Python mapping to 3.11 because Python 3.12+ removed distutils from the standard library, causing broken cross-references in the deprecated distutils docs. Fix by converting all 199 Sphinx cross-references (:mod:, :class:, :func:, :exc:) to distutils in the deprecated docs to plain code literals (distutils.*). These docs are setuptools-hosted copies and don't need intersphinx resolution. This allows the intersphinx Python mapping to point to the latest Python 3 docs instead of being pinned to 3.11. Fixes pypa#4081
Author
|
Closing this PR as it's a trivial documentation change that doesn't add meaningful value. Apologies for the noise. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
PR #4078 pinned the intersphinx Python mapping to 3.11 because Python 3.12+ removed distutils from the standard library, causing broken cross-references in the deprecated distutils docs.
Fix
Convert all 199 Sphinx cross-references (
:mod:,:class:,:func:,:exc:) to distutils in the deprecated docs to plain code literals. These docs are setuptools-hosted copies and don't need intersphinx resolution.This allows the intersphinx Python mapping to point to the latest Python 3 docs instead of being pinned to 3.11.
Changes
docs/conf.py— Remove Python 3.11 pin, usepython=('https://docs.python.org/3', None)docs/deprecated/distutils/*.rst— Convert 199 cross-references to plain code literalsFiles modified
apiref.rst(159 refs)setupscript.rst(22 refs)extending.rst(7 refs)examples.rst(5 refs)builtdist.rst(4 refs)introduction.rst(1 ref)sourcedist.rst(1 ref)Fixes #4081