Skip to content

Update distutils references to use setuptools-hosted docs#5187

Open
realMelTuc wants to merge 1 commit intopypa:mainfrom
realMelTuc:fix-distutils-references
Open

Update distutils references to use setuptools-hosted docs#5187
realMelTuc wants to merge 1 commit intopypa:mainfrom
realMelTuc:fix-distutils-references

Conversation

@realMelTuc
Copy link

This PR addresses issue #4081 by updating the distutils documentation references to point to the setuptools-hosted documentation instead of CPython docs.

Changes Made

  1. **Updated **: Changed the distutils reference from to

  2. **Updated **: Removed the workaround that pinned the intersphinx mapping to Python 3.11 (which was added in PR Fix failing CI jobs #4078 to avoid errors with broken distutils references in Python 3.12+). Now the docs can use the latest Python documentation.

Rationale

  • CPython 3.12+ removed distutils from the standard library, causing broken references in the official Python docs
  • Setuptools now hosts the distutils documentation at https://setuptools.pypa.io/en/latest/deprecated/distutils/
  • By updating our references to point to the setuptools-hosted documentation, we ensure that:
    • The documentation links will remain working
    • We don't need to pin to older Python versions
    • We provide better support for users who need distutils documentation

Testing

The changes have been tested locally to ensure:

  • The documentation builds successfully
  • The references are correct and point to the right documentation
  • The workaround removal doesn't break the build process

Closes #4081

- Change distutils reference in extension.rst to point to setuptools.pypa.io
- Remove workaround in docs/conf.py that pinned Python docs to 3.11
- This resolves the issue where docs builds were failing due to broken
  references to distutils in CPython docs for Python 3.12+.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Remove references to distutils in CPython

1 participant