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.

Sign up for GitHub

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

Jump to bottom

gh-101100: Fix Sphinx warnings for removed dead batteries #113669

Merged
merged 5 commits into from
Jan 3, 2024
Merged

gh-101100: Fix Sphinx warnings for removed dead batteries #113669

merged 5 commits into from
Jan 3, 2024

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Jan 2, 2024 •
edited by github-actions bot
Loading

Fix 58 warnings for modules removed by PEP 594: "Removing dead batteries from the standard library":

Doc/whatsnew/2.0.rst:1098: WARNING: py:mod reference target not found: linuxaudiodev
Doc/whatsnew/2.0.rst:1098: WARNING: py:mod reference target not found: sunaudiodev
Doc/whatsnew/2.4.rst:998: WARNING: py:mod reference target not found: asyncore
Doc/whatsnew/2.6.rst:1792: WARNING: py:mod reference target not found: asyncore
Doc/whatsnew/2.6.rst:1792: WARNING: py:mod reference target not found: asynchat
Doc/whatsnew/2.6.rst:2927: WARNING: py:mod reference target not found: audiodev
Doc/whatsnew/2.6.rst:2927: WARNING: py:mod reference target not found: linuxaudiodev
Doc/whatsnew/2.6.rst:2927: WARNING: py:mod reference target not found: sunaudiodev
Doc/whatsnew/3.11.rst:1750: WARNING: py:mod reference target not found: asynchat
Doc/whatsnew/3.11.rst:1750: WARNING: py:mod reference target not found: asyncore
Doc/whatsnew/3.11.rst:1750: WARNING: py:mod reference target not found: smtpd
Doc/whatsnew/3.11.rst:1880: WARNING: py:mod reference target not found: asynchat
Doc/whatsnew/3.11.rst:1881: WARNING: py:mod reference target not found: asyncore
Doc/whatsnew/3.11.rst:2010: WARNING: py:mod reference target not found: smtpd
Doc/whatsnew/3.2.rst:1861: WARNING: py:class reference target not found: asyncore.dispatcher
Doc/whatsnew/3.2.rst:1861: WARNING: py:meth reference target not found: asyncore.dispatcher.handle_accepted
Doc/whatsnew/3.2.rst:1861: WARNING: py:meth reference target not found: asyncore.dispatcher.handle_accept
Doc/whatsnew/3.2.rst:1861: WARNING: py:meth reference target not found: asyncore.dispatcher.accept
Doc/whatsnew/3.2.rst:2740: WARNING: py:func reference target not found: asyncore.handle_accept
Doc/whatsnew/3.2.rst:2740: WARNING: py:func reference target not found: asyncore.handle_accepted
Doc/whatsnew/3.3.rst:1848: WARNING: py:mod reference target not found: smtpd
Doc/whatsnew/3.4.rst:1372: WARNING: py:class reference target not found: smtpd.SMTPServer
Doc/whatsnew/3.4.rst:1372: WARNING: py:class reference target not found: smtpd.SMTPChannel
Doc/whatsnew/3.4.rst:1372: WARNING: py:class reference target not found: asynchat.async_chat
Doc/whatsnew/3.4.rst:2373: WARNING: py:attr reference target not found: cgi.FieldStorage.file
Doc/whatsnew/3.5.rst:881: WARNING: py:class reference target not found: cgi.FieldStorage
Doc/whatsnew/3.5.rst:1666: WARNING: py:class reference target not found: smtpd.SMTPServer
Doc/whatsnew/3.5.rst:1666: WARNING: py:class reference target not found: smtpd.SMTPChannel
Doc/whatsnew/3.5.rst:1666: WARNING: py:meth reference target not found: smtpd.SMTPServer.process_message
Doc/whatsnew/3.5.rst:1677: WARNING: py:class reference target not found: smtpd.SMTPServer
Doc/whatsnew/3.5.rst:1677: WARNING: py:meth reference target not found: smtpd.SMTPServer.process_message
Doc/whatsnew/3.5.rst:1684: WARNING: py:class reference target not found: smtpd.SMTPServer
Doc/whatsnew/3.5.rst:1684: WARNING: py:meth reference target not found: smtpd.SMTPServer.process_message
Doc/whatsnew/3.5.rst:1692: WARNING: py:class reference target not found: smtpd.SMTPServer
Doc/whatsnew/3.5.rst:1717: WARNING: py:func reference target not found: sndhdr.what
Doc/whatsnew/3.5.rst:1717: WARNING: py:func reference target not found: sndhdr.whathdr
Doc/whatsnew/3.5.rst:2299: WARNING: py:mod reference target not found: smtpd
Doc/whatsnew/3.5.rst:2299: WARNING: py:class reference target not found: smtpd.SMTPServer
Doc/whatsnew/3.6.rst:1964: WARNING: py:mod reference target not found: asynchat
Doc/whatsnew/3.6.rst:1971: WARNING: py:mod reference target not found: asyncore
Doc/whatsnew/3.6.rst:2187: WARNING: py:mod reference target not found: smtpd
Doc/whatsnew/3.6.rst:2222: WARNING: py:class reference target not found: smtpd.SMTPChannel
Doc/whatsnew/3.6.rst:2222: WARNING: py:class reference target not found: smtpd.SMTPServer
Doc/whatsnew/3.6.rst:2222: WARNING: py:meth reference target not found: smtpd.SMTPServer.process_message
Doc/whatsnew/3.7.rst:2307: WARNING: py:func reference target not found: cgi.parse_multipart
Doc/whatsnew/3.9.rst:934: WARNING: py:func reference target not found: smtpd.MailmanProxy
build/NEWS:6679: WARNING: py:mod reference target not found: asyncore
build/NEWS:6679: WARNING: py:mod reference target not found: asynchat
build/NEWS:8169: WARNING: py:mod reference target not found: smtpd
build/NEWS:10143: WARNING: py:mod reference target not found: asynchat
build/NEWS:10143: WARNING: py:mod reference target not found: asyncore
build/NEWS:10143: WARNING: py:mod reference target not found: smtpd
build/NEWS:10362: WARNING: py:mod reference target not found: asyncore
build/NEWS:13815: WARNING: py:class reference target not found: smtpd.MailmanProxy
build/NEWS:18404: WARNING: py:obj reference target not found: cgi.parse_multipart
build/NEWS:25609: WARNING: py:obj reference target not found: crypt
build/NEWS:25609: WARNING: py:obj reference target not found: crypt_r()
build/NEWS:25609: WARNING: py:obj reference target not found: crypt()

These removals began in 3.12, and the bulk were in 3.13. So some need backporting to 3.12, and we don't need to backport to 3.11.

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

@hugovk hugovk added docs Documentation in the Doc dir skip news needs backport to 3.12 bug and security fixes labels Jan 2, 2024
@bedevere-app bedevere-app bot mentioned this pull request Jan 2, 2024
Open
AlexWaygood
AlexWaygood reviewed Jan 3, 2024
View reviewed changes
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, just a couple of suggestions to fix some adjacent warnings while we're here:

Doc/whatsnew/2.4.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.11.rst Show resolved Hide resolved
Doc/whatsnew/3.7.rst Outdated Show resolved Hide resolved
@hugovk
Copy link
Member Author

hugovk commented Jan 3, 2024 •
edited
Loading

Thanks, these 10 also now fixed:

/Users/hugo/github/python/cpython/main/Doc/whatsnew/2.4.rst:998: WARNING: py:func reference target not found: loop
/Users/hugo/github/python/cpython/main/Doc/whatsnew/3.10.rst:1280: WARNING: py:meth reference target not found: pathlib.Path.link_to
/Users/hugo/github/python/cpython/main/Doc/whatsnew/3.10.rst:1743: WARNING: py:meth reference target not found: pathlib.Path.link_to
/Users/hugo/github/python/cpython/main/Doc/whatsnew/3.10.rst:1774: WARNING: 'envvar' reference target not found: PYTHONTHREADDEBUG
/Users/hugo/github/python/cpython/main/Doc/whatsnew/3.11.rst:1905: WARNING: py:meth reference target not found: pathlib.Path.link_to
/Users/hugo/github/python/cpython/main/Doc/whatsnew/3.11.rst:1908: WARNING: 'envvar' reference target not found: PYTHONTHREADDEBUG
/Users/hugo/github/python/cpython/main/Doc/whatsnew/3.7.rst:2307: WARNING: py:class reference target not found: FieldStorage
/Users/hugo/github/python/cpython/main/Doc/whatsnew/3.8.rst:1089: WARNING: py:meth reference target not found: pathlib.Path.link_to
/Users/hugo/github/python/cpython/main/build/NEWS:13070: WARNING: 'envvar' reference target not found: PYTHONTHREADDEBUG
/Users/hugo/github/python/cpython/main/build/NEWS:23944: WARNING: py:obj reference target not found: pathlib.path.link_to()

Edit: include that extra one :)

AlexWaygood
AlexWaygood approved these changes Jan 3, 2024
View reviewed changes
Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved
@hugovk @AlexWaygood
Fix PYTHONTHREADDEBUG Sphinx warnings
7ca7120 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@hugovk hugovk enabled auto-merge (squash) January 3, 2024 12:58
@hugovk hugovk merged commit fab7ad6 into python:main Jan 3, 2024
23 checks passed
@hugovk hugovk deleted the docs-fix-sphinx-warnings-dead-batteries branch January 3, 2024 13:04
@miss-islington-app
Copy link

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 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 fab7ad62ceca1f88767bca4e1f06f8e4b1faef2f 3.12

@bedevere-app
Copy link

bedevere-app bot commented Jan 3, 2024

GH-113681 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 Jan 3, 2024
hugovk added a commit to hugovk/cpython that referenced this pull request Jan 3, 2024
@hugovk
[3.12] pythongh-101100: Fix Sphinx warnings for removed dead batteries (
5e0feee 
pythonGH-113669)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit fab7ad6)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Jan 3, 2024
@hugovk
[3.12] gh-101100: Fix Sphinx warnings for removed dead batteries (GH-…
d2cdc67 
…113669) (#113681)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
kulikjak pushed a commit to kulikjak/cpython that referenced this pull request Jan 22, 2024
@hugovk @AlexWaygood @kulikjak
pythongh-101100: Fix Sphinx warnings for removed dead batteries (pyth…
e1abaed 
…on#113669)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@hugovk @AlexWaygood @aisk
pythongh-101100: Fix Sphinx warnings for removed dead batteries (pyth…
ed8015c 
…on#113669)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@hugovk @AlexWaygood @Glyphack
pythongh-101100: Fix Sphinx warnings for removed dead batteries (pyth…
0c81680 
…on#113669)

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
Reviewers

@AlexWaygood AlexWaygood AlexWaygood approved these changes

Assignees

@hugovk hugovk

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.
2 participants
@hugovk @AlexWaygood