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-101100: Fix Sphinx warnings from PEP 3108 stdlib re-organisation #114327

Merged
merged 5 commits into from
Feb 4, 2024

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Jan 19, 2024

PEP 3108 "Standard Library Reorganization" lists a number of modules that were removed and renamed in Python 3.

This fixes 124 warnings from those modules, plus some neighbouring warnings in affected paragraphs:

Doc/whatsnew/2.0.rst:1037: WARNING: py:mod reference target not found: httplib
Doc/whatsnew/2.0.rst:1046: WARNING: py:mod reference target not found: httplib
Doc/whatsnew/2.0.rst:1046: WARNING: py:mod reference target not found: httplib
Doc/whatsnew/2.0.rst:1111: WARNING: py:mod reference target not found: robotparser
Doc/whatsnew/2.0.rst:1132: WARNING: py:mod reference target not found: _winreg
Doc/whatsnew/2.0.rst:1132: WARNING: py:mod reference target not found: _winreg
Doc/whatsnew/2.0.rst:1132: WARNING: py:mod reference target not found: _winreg
Doc/whatsnew/2.2.rst:52: WARNING: py:mod reference target not found: UserList
Doc/whatsnew/2.2.rst:52: WARNING: py:class reference target not found: UserList
Doc/whatsnew/2.2.rst:70: WARNING: py:meth reference target not found: __getattr__
Doc/whatsnew/2.2.rst:936: WARNING: py:mod reference target not found: xmlrpclib
Doc/whatsnew/2.2.rst:959: WARNING: py:mod reference target not found: SimpleXMLRPCServer
Doc/whatsnew/2.2.rst:965: WARNING: py:attr reference target not found: tm_year
Doc/whatsnew/2.2.rst:965: WARNING: py:func reference target not found: fstat
Doc/whatsnew/2.2.rst:965: WARNING: py:func reference target not found: statvfs
Doc/whatsnew/2.2.rst:965: WARNING: py:func reference target not found: fstatvfs
Doc/whatsnew/2.2.rst:965: WARNING: py:func reference target not found: localtime
Doc/whatsnew/2.2.rst:965: WARNING: py:func reference target not found: gmtime
Doc/whatsnew/2.2.rst:965: WARNING: py:func reference target not found: strptime
Doc/whatsnew/2.4.rst:1084: WARNING: py:mod reference target not found: httplib
Doc/whatsnew/2.4.rst:1221: WARNING: py:mod reference target not found: rfc822
Doc/whatsnew/2.4.rst:1221: WARNING: py:func reference target not found: email.Utils.formatdate
Doc/whatsnew/2.4.rst:1221: WARNING: py:func reference target not found: rfc822.formatdate
Doc/whatsnew/2.4.rst:1311: WARNING: py:mod reference target not found: xmlrpclib
Doc/whatsnew/2.4.rst:1326: WARNING: py:mod reference target not found: cookielib
Doc/whatsnew/2.4.rst:1326: WARNING: py:mod reference target not found: Cookie
Doc/whatsnew/2.4.rst:1338: WARNING: py:mod reference target not found: urllib2
Doc/whatsnew/2.4.rst:1338: WARNING: py:mod reference target not found: cookielib
Doc/whatsnew/2.5.rst:1481: WARNING: py:mod reference target not found: cPickle
Doc/whatsnew/2.5.rst:1481: WARNING: py:meth reference target not found: __reduce__
Doc/whatsnew/2.5.rst:1522: WARNING: py:mod reference target not found: SimpleXMLRPCServer
Doc/whatsnew/2.5.rst:1522: WARNING: py:mod reference target not found: DocXMLRPCServer
Doc/whatsnew/2.5.rst:1653: WARNING: py:mod reference target not found: xmlrpclib
Doc/whatsnew/2.5.rst:1653: WARNING: py:func reference target not found: loads
Doc/whatsnew/2.5.rst:1653: WARNING: py:class reference target not found: Unmarshaller
Doc/whatsnew/2.5.rst:2256: WARNING: py:mod reference target not found: cPickle
Doc/whatsnew/2.5.rst:2256: WARNING: py:meth reference target not found: __reduce__
Doc/whatsnew/2.5.rst:2261: WARNING: py:mod reference target not found: SimpleXMLRPCServer
Doc/whatsnew/2.5.rst:2261: WARNING: py:mod reference target not found: DocXMLRPCServer
Doc/whatsnew/2.6.rst:1083: WARNING: py:mod reference target not found: StringIO
Doc/whatsnew/2.6.rst:1083: WARNING: py:mod reference target not found: cStringIO
Doc/whatsnew/2.6.rst:1809: WARNING: py:mod reference target not found: urlparse
Doc/whatsnew/2.6.rst:1898: WARNING: py:mod reference target not found: Cookie
Doc/whatsnew/2.6.rst:1898: WARNING: py:class reference target not found: Morsel
Doc/whatsnew/2.6.rst:1898: WARNING: py:attr reference target not found: httponly
Doc/whatsnew/2.6.rst:1989: WARNING: py:class reference target not found: httplib.HTTPConnection
Doc/whatsnew/2.6.rst:1989: WARNING: py:class reference target not found: HTTPSConnection
Doc/whatsnew/2.6.rst:2374: WARNING: py:mod reference target not found: SocketServer
Doc/whatsnew/2.6.rst:2374: WARNING: py:meth reference target not found: handle_timeout
Doc/whatsnew/2.6.rst:2374: WARNING: py:attr reference target not found: timeout
Doc/whatsnew/2.6.rst:2374: WARNING: py:meth reference target not found: serve_forever
Doc/whatsnew/2.6.rst:2481: WARNING: py:mod reference target not found: test.test_support
Doc/whatsnew/2.6.rst:2481: WARNING: py:func reference target not found: EnvironmentVarGuard
Doc/whatsnew/2.6.rst:2579: WARNING: py:func reference target not found: urllib.urlopen
Doc/whatsnew/2.6.rst:2579: WARNING: py:func reference target not found: urllib2.urlopen
Doc/whatsnew/2.6.rst:2607: WARNING: py:class reference target not found: SimpleXMLRPCServer
Doc/whatsnew/2.6.rst:2607: WARNING: py:class reference target not found: DocXMLRPCServer
Doc/whatsnew/2.6.rst:2624: WARNING: py:mod reference target not found: xmlrpclib
Doc/whatsnew/2.6.rst:2624: WARNING: py:class reference target not found: xmlrpclib.DateTime
Doc/whatsnew/2.6.rst:2624: WARNING: py:mod reference target not found: xmlrpclib
Doc/whatsnew/2.6.rst:3277: WARNING: py:mod reference target not found: xmlrpclib
Doc/whatsnew/2.6.rst:3277: WARNING: py:class reference target not found: xmlrpclib.DateTime
Doc/whatsnew/2.6.rst:3277: WARNING: py:mod reference target not found: xmlrpclib
Doc/whatsnew/2.7.rst:917: WARNING: py:mod reference target not found: Cookie
Doc/whatsnew/2.7.rst:1015: WARNING: py:mod reference target not found: cPickle
Doc/whatsnew/2.7.rst:1020: WARNING: py:mod reference target not found: cPickle
Doc/whatsnew/2.7.rst:1166: WARNING: py:mod reference target not found: cookielib
Doc/whatsnew/2.7.rst:1309: WARNING: py:class reference target not found: httplib.HTTPResponse
Doc/whatsnew/2.7.rst:1309: WARNING: py:mod reference target not found: httplib
Doc/whatsnew/2.7.rst:1313: WARNING: py:class reference target not found: httplib.HTTPConnection
Doc/whatsnew/2.7.rst:1313: WARNING: py:class reference target not found: httplib.HTTPSConnection
Doc/whatsnew/2.7.rst:1521: WARNING: py:mod reference target not found: SocketServer
Doc/whatsnew/2.7.rst:1521: WARNING: py:class reference target not found: SocketServer.TCPServer
Doc/whatsnew/2.7.rst:1521: WARNING: py:attr reference target not found: SocketServer.TCPServer.disable_nagle_algorithm
Doc/whatsnew/2.7.rst:1521: WARNING: py:attr reference target not found: SocketServer.BaseServer.timeout
Doc/whatsnew/2.7.rst:1521: WARNING: py:meth reference target not found: SocketServer.BaseServer.handle_timeout
Doc/whatsnew/2.7.rst:1521: WARNING: py:meth reference target not found: SocketServer.BaseServer.handle_request
Doc/whatsnew/2.7.rst:1651: WARNING: py:mod reference target not found: urlparse
Doc/whatsnew/2.7.rst:1651: WARNING: py:func reference target not found: urlparse.urlsplit
Doc/whatsnew/2.7.rst:1678: WARNING: py:mod reference target not found: urlparse
Doc/whatsnew/2.7.rst:1700: WARNING: py:mod reference target not found: xmlrpclib
Doc/whatsnew/2.7.rst:1700: WARNING: py:mod reference target not found: SimpleXMLRPCServer
Doc/whatsnew/2.7.rst:2337: WARNING: py:mod reference target not found: _winreg
Doc/whatsnew/2.7.rst:2337: WARNING: py:func reference target not found: _winreg.CreateKeyEx
Doc/whatsnew/2.7.rst:2337: WARNING: py:func reference target not found: _winreg.DeleteKeyEx
Doc/whatsnew/2.7.rst:2337: WARNING: py:func reference target not found: _winreg.DisableReflectionKey
Doc/whatsnew/2.7.rst:2337: WARNING: py:func reference target not found: _winreg.EnableReflectionKey
Doc/whatsnew/2.7.rst:2337: WARNING: py:func reference target not found: _winreg.QueryReflectionKey
Doc/whatsnew/2.7.rst:2511: WARNING: py:mod reference target not found: urlparse
Doc/whatsnew/2.7.rst:2511: WARNING: py:func reference target not found: urlparse.urlsplit
Doc/whatsnew/2.7.rst:2714: WARNING: py:mod reference target not found: httplib
Doc/whatsnew/2.7.rst:2714: WARNING: py:mod reference target not found: urllib2
Doc/whatsnew/3.0.rst:340: WARNING: py:mod reference target not found: StringIO
Doc/whatsnew/3.0.rst:340: WARNING: py:mod reference target not found: cStringIO
Doc/whatsnew/3.0.rst:566: WARNING: py:mod reference target not found: bsddb3
Doc/whatsnew/3.0.rst:588: WARNING: py:mod reference target not found: cPickle
Doc/whatsnew/3.0.rst:588: WARNING: py:mod reference target not found: cPickle
Doc/whatsnew/3.0.rst:588: WARNING: py:mod reference target not found: StringIO
Doc/whatsnew/3.0.rst:606: WARNING: py:mod reference target not found: anydbm
Doc/whatsnew/3.0.rst:606: WARNING: py:mod reference target not found: dbhash
Doc/whatsnew/3.0.rst:606: WARNING: py:mod reference target not found: dumbdbm
Doc/whatsnew/3.0.rst:606: WARNING: py:mod reference target not found: gdbm
Doc/whatsnew/3.0.rst:606: WARNING: py:mod reference target not found: whichdb
Doc/whatsnew/3.0.rst:609: WARNING: py:mod reference target not found: HTMLParser
Doc/whatsnew/3.0.rst:609: WARNING: py:mod reference target not found: htmlentitydefs
Doc/whatsnew/3.0.rst:611: WARNING: py:mod reference target not found: httplib
Doc/whatsnew/3.0.rst:611: WARNING: py:mod reference target not found: BaseHTTPServer
Doc/whatsnew/3.0.rst:611: WARNING: py:mod reference target not found: CGIHTTPServer
Doc/whatsnew/3.0.rst:611: WARNING: py:mod reference target not found: SimpleHTTPServer
Doc/whatsnew/3.0.rst:611: WARNING: py:mod reference target not found: Cookie
Doc/whatsnew/3.0.rst:611: WARNING: py:mod reference target not found: cookielib
Doc/whatsnew/3.0.rst:620: WARNING: py:mod reference target not found: urllib2
Doc/whatsnew/3.0.rst:620: WARNING: py:mod reference target not found: urlparse
Doc/whatsnew/3.0.rst:620: WARNING: py:mod reference target not found: robotparse
Doc/whatsnew/3.0.rst:623: WARNING: py:mod reference target not found: xmlrpclib
Doc/whatsnew/3.0.rst:623: WARNING: py:mod reference target not found: DocXMLRPCServer
Doc/whatsnew/3.0.rst:623: WARNING: py:mod reference target not found: SimpleXMLRPCServer
Doc/whatsnew/3.0.rst:645: WARNING: py:mod reference target not found: thread
Doc/whatsnew/3.0.rst:645: WARNING: py:func reference target not found: acquire_lock
Doc/whatsnew/3.0.rst:645: WARNING: py:func reference target not found: release_lock
Doc/whatsnew/3.0.rst:645: WARNING: py:func reference target not found: acquire
Doc/whatsnew/3.0.rst:645: WARNING: py:func reference target not found: release
Doc/whatsnew/3.5.rst:2420: WARNING: py:meth reference target not found: HTMLParser.error
Doc/whatsnew/3.5.rst:2420: WARNING: py:exc reference target not found: HTMLParserError

📚 Documentation preview 📚: https://cpython-previews--114327.org.readthedocs.build/

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting core review labels Jan 19, 2024
@hugovk hugovk added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Jan 19, 2024
@AA-Turner AA-Turner self-requested a review January 23, 2024 00:34
@AlexWaygood AlexWaygood changed the title gh-101100: Fix Sphinx warnings from PEP 3108 stdblib re-organisation gh-101100: Fix Sphinx warnings from PEP 3108 stdlib re-organisation Feb 3, 2024
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Some minor nits below:

Doc/whatsnew/2.0.rst Outdated Show resolved Hide resolved
Doc/whatsnew/2.0.rst Outdated Show resolved Hide resolved
Doc/whatsnew/2.0.rst Outdated Show resolved Hide resolved
Doc/whatsnew/2.2.rst Outdated Show resolved Hide resolved
Doc/whatsnew/2.2.rst Outdated Show resolved Hide resolved
Doc/whatsnew/2.7.rst Outdated Show resolved Hide resolved
Doc/whatsnew/2.7.rst Outdated Show resolved Hide resolved
Doc/whatsnew/2.7.rst Outdated Show resolved Hide resolved
Doc/whatsnew/2.7.rst Outdated Show resolved Hide resolved
Doc/whatsnew/2.7.rst Outdated Show resolved Hide resolved
hugovk and others added 3 commits February 3, 2024 14:05
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@hugovk
Copy link
Member Author

hugovk commented Feb 3, 2024

Thank you for the suggestions!

And resolved the merge conflict. Which was caused by my own changes in another PR! But this PR mostly had better changes (except one bit, which I kept).

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(spotted one more thing, sorry!)

Doc/whatsnew/3.0.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.0.rst Outdated Show resolved Hide resolved
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@hugovk hugovk enabled auto-merge (squash) February 4, 2024 09:40
@hugovk hugovk merged commit 848c867 into python:main Feb 4, 2024
23 checks passed
@hugovk hugovk deleted the docs-fix-sphinx-warnings-pep3108 branch February 4, 2024 09:45
@miss-islington-app
Copy link

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Sorry, @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 848c86786be588312bff948441929816cdd19e28 3.12

@miss-islington-app
Copy link

Sorry, @hugovk, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 848c86786be588312bff948441929816cdd19e28 3.11

hugovk added a commit to hugovk/cpython that referenced this pull request Feb 4, 2024
…tion (python#114327)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 848c867)
@bedevere-app
Copy link

bedevere-app bot commented Feb 4, 2024

GH-114988 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Feb 4, 2024
@bedevere-app
Copy link

bedevere-app bot commented Feb 4, 2024

GH-114989 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Feb 4, 2024
hugovk added a commit to hugovk/cpython that referenced this pull request Feb 4, 2024
…rganisation (pythonGH-114327)

* Fix Sphinx warnings from PEP 3108 stdblib re-organisation

* Apply suggestions from code review

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Update Doc/whatsnew/2.2.rst

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Apply suggestions from code review

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

---------

(cherry picked from commit 848c867)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
hugovk added a commit that referenced this pull request Feb 4, 2024
…ation (GH-114327) (#114988)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Fix Sphinx warnings from PEP 3108 stdlib re-organisation (#114327)
hugovk added a commit that referenced this pull request Feb 4, 2024
…ation (GH-114327) (#114989)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
…tion (python#114327)

* Fix Sphinx warnings from PEP 3108 stdblib re-organisation

* Apply suggestions from code review

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Update Doc/whatsnew/2.2.rst

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Apply suggestions from code review

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

---------

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
fsc-eriker pushed a commit to fsc-eriker/cpython that referenced this pull request Feb 14, 2024
…tion (python#114327)

* Fix Sphinx warnings from PEP 3108 stdblib re-organisation

* Apply suggestions from code review

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Update Doc/whatsnew/2.2.rst

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Apply suggestions from code review

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

---------

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
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.

2 participants