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 in whatsnew/3.10.rst #118356

Merged
merged 2 commits into from Apr 28, 2024

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Apr 27, 2024

Fix 30 Sphinx warnings in Doc/whatsnew/3.10.rst:

whatsnew/3.10.rst:355: WARNING: c:func reference target not found: PyErr_Display
whatsnew/3.10.rst:369: WARNING: c:func reference target not found: PyErr_Display
whatsnew/3.10.rst:376: WARNING: c:func reference target not found: PyErr_Display
whatsnew/3.10.rst:391: WARNING: c:func reference target not found: PyErr_Display
whatsnew/3.10.rst:693: WARNING: py:class reference target not found: TextIOWrapper
whatsnew/3.10.rst:788: WARNING: py:data reference target not found: TypeAlias
whatsnew/3.10.rst:801: WARNING: py:data reference target not found: TypeGuard
whatsnew/3.10.rst:801: WARNING: py:data reference target not found: TypeGuard
whatsnew/3.10.rst:975: WARNING: py:class reference target not found: AsyncContextDecorator
whatsnew/3.10.rst:1092: WARNING: py:class reference target not found: Enum
whatsnew/3.10.rst:1092: WARNING: py:func reference target not found: __repr__
whatsnew/3.10.rst:1092: WARNING: py:func reference target not found: __str__
whatsnew/3.10.rst:1107: WARNING: py:class reference target not found: TextIOWrapper
whatsnew/3.10.rst:1202: WARNING: py:class reference target not found: importlib.metadata.EntryPoints
whatsnew/3.10.rst:1208: WARNING: py:func reference target not found: importlib.metadata.packages_distributions
whatsnew/3.10.rst:1208: WARNING: py:class reference target not found: importlib.metadata.Distribution
whatsnew/3.10.rst:1218: WARNING: py:func reference target not found: inspect.Signature.from_function
whatsnew/3.10.rst:1485: WARNING: py:func reference target not found: runtime_checkable
whatsnew/3.10.rst:1485: WARNING: py:func reference target not found: runtime_checkable
whatsnew/3.10.rst:1598: WARNING: py:class reference target not found: BZ2File
whatsnew/3.10.rst:1598: WARNING: py:class reference target not found: BZ2File
whatsnew/3.10.rst:1619: WARNING: py:meth reference target not found: importlib.abc.Finder.find_spec
whatsnew/3.10.rst:1650: WARNING: py:meth reference target not found: zimport.zipimporter.load_module
whatsnew/3.10.rst:1762: WARNING: py:attr reference target not found: sslSSLContext.minimum_version
whatsnew/3.10.rst:1762: WARNING: py:attr reference target not found: sslSSLContext.maximum_version
whatsnew/3.10.rst:1768: WARNING: py:data reference target not found: ssl.PROTOCOL_SSLv2
whatsnew/3.10.rst:1774: WARNING: py:func reference target not found: ssl.wrap_socket
whatsnew/3.10.rst:1776: WARNING: py:func reference target not found: ssl.match_hostname
whatsnew/3.10.rst:1778: WARNING: py:func reference target not found: ssl.RAND_pseudo_bytes
whatsnew/3.10.rst:1778: WARNING: py:func reference target not found: ssl.RAND_egd

I wasn't sure what to do about the remaining four so left them:

whatsnew/3.10.rst:903: WARNING: py:meth reference target not found: asyncio.events.AbstractEventLoop.connect_accepted_socket
whatsnew/3.10.rst:935: WARNING: py:meth reference target not found: bdb.Breakpoint.clearBreakpoints
whatsnew/3.10.rst:1086: WARNING: py:func reference target not found: encodings.normalize_encoding
whatsnew/3.10.rst:1400: WARNING: py:func reference target not found: sqlite3.connect/handle

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

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting core review labels Apr 27, 2024
@hugovk hugovk changed the title gh-101100: Fix Sphinx warnings in whatsnew/3.10.rst gh-101100: Fix Sphinx warnings in whatsnew/3.10.rst Apr 27, 2024
:data:`!PROTOCOL_SSLv23`, :data:`!PROTOCOL_TLSv1`,
:data:`!PROTOCOL_TLSv1_1`, :data:`!PROTOCOL_TLSv1_2`, and
:const:`!PROTOCOL_TLS` are deprecated in favor of
:const:`!PROTOCOL_TLS_CLIENT` and :const:`!PROTOCOL_TLS_SERVER`
Copy link
Member

Choose a reason for hiding this comment

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

Huh, it looks like PROTOCOL_TLS_CLIENT is documented -- was the link not working correctly? https://docs.python.org/3/library/ssl.html#ssl.PROTOCOL_TLS_CLIENT

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah yes, just need ~ssl.

Updated, 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.

Thanks!

@hugovk
Copy link
Member Author

hugovk commented Apr 28, 2024

And thanks for the reviews!

@hugovk hugovk added the needs backport to 3.12 bug and security fixes label Apr 28, 2024
@hugovk hugovk merged commit f5b7e39 into python:main Apr 28, 2024
28 checks passed
@hugovk hugovk deleted the docs-fix-sphinx-warnings-whatsnew-3.10 branch April 28, 2024 18:12
@miss-islington-app
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 28, 2024
…-118356)

(cherry picked from commit f5b7e39)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Apr 28, 2024

GH-118367 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 Apr 28, 2024
hugovk added a commit that referenced this pull request Apr 28, 2024
…) (#118367)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.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.

None yet

2 participants