Skip to content

Conversation

@hugovk
Copy link
Member

@hugovkhugovk commented Dec 12, 2023

Fix 55 Sphinx warnings involving asterisks (and a couple of neighbours):

Doc/library/bdb.rst:296: WARNING: py:meth reference target not found: dispatch_* Doc/library/cmd.rst:84: WARNING: py:meth reference target not found: do_* Doc/library/cmd.rst:96: WARNING: py:meth reference target not found: help_* Doc/library/cmd.rst:107: WARNING: py:meth reference target not found: do_* Doc/library/cmd.rst:130: WARNING: py:meth reference target not found: complete_* Doc/library/cmd.rst:211: WARNING: py:meth reference target not found: help_* Doc/library/cmd.rst:211: WARNING: py:meth reference target not found: do_* Doc/library/cmd.rst:218: WARNING: py:meth reference target not found: do_* Doc/library/cmd.rst:218: WARNING: py:meth reference target not found: help_* Doc/library/configparser.rst:955: WARNING: py:meth reference target not found: get* Doc/library/csv.rst:434: WARNING: py:const reference target not found: QUOTE_* Doc/library/http.server.rst:66: WARNING: py:meth reference target not found: do_SPAM Doc/library/http.server.rst:188: WARNING: py:meth reference target not found: do_* Doc/library/http.server.rst:195: WARNING: py:meth reference target not found: do_* Doc/library/locale.rst:311: WARNING: py:const reference target not found: LC_* Doc/library/os.rst:4170: WARNING: py:func reference target not found: execl* Doc/library/os.rst:4707: WARNING: py:func reference target not found: spawnl* Doc/library/os.rst:4760: WARNING: py:func reference target not found: spawn* Doc/library/os.rst:4770: WARNING: py:func reference target not found: spawn* Doc/library/resource.rst:278: WARNING: py:const reference target not found: RUSAGE_* Doc/library/resource.rst:356: WARNING: py:const reference target not found: RUSAGE_* Doc/library/socket.rst:309: WARNING: py:const reference target not found: EAI_* Doc/library/socket.rst:1519: WARNING: py:const reference target not found: SO_* Doc/library/socket.rst:1939: WARNING: py:const reference target not found: SO_* Doc/library/unittest.rst:393: WARNING: py:meth reference target not found: assert* Doc/library/unittest.rst:1943: WARNING: py:meth reference target not found: loadTestsFrom* Doc/library/unittest.rst:1949: WARNING: py:meth reference target not found: loadTestsFrom* Doc/library/unittest.rst:1959: WARNING: py:meth reference target not found: loadTestsFrom* Doc/library/unittest.rst:1972: WARNING: py:meth reference target not found: loadTestsFrom* Doc/library/unittest.rst:2004: WARNING: py:meth reference target not found: TestCase.assert* Doc/library/urllib.request.rst:714: WARNING: py:class reference target not found: *Processor Doc/library/urllib.request.rst:714: WARNING: py:class reference target not found: *Handler Doc/library/urllib.request.rst:835: WARNING: py:meth reference target not found: http_error_30* Doc/library/urllib.request.rst:835: WARNING: py:meth reference target not found: http_error_30* Doc/library/xml.dom.rst:736: WARNING: py:meth reference target not found: getAttribute* Doc/whatsnew/2.3.rst:1365: WARNING: py:func reference target not found: *stat Doc/whatsnew/2.4.rst:1165: WARNING: py:func reference target not found: l*gettext Doc/whatsnew/2.5.rst:1168: WARNING: py:meth reference target not found: read* Doc/whatsnew/2.5.rst:1168: WARNING: py:meth reference target not found: read* Doc/whatsnew/2.7.rst:1420: WARNING: py:class reference target not found: Manager* Doc/whatsnew/3.4.rst:1936: WARNING: 'envvar' reference target not found: PYTHON* build/NEWS:3928: WARNING: 'opcode' reference target not found: CALL_INTRINSIC_* build/NEWS:7304: WARNING: 'envvar' reference target not found: PYTHON* build/NEWS:17517: WARNING: py:obj reference target not found: PyPegen* build/NEWS:17517: WARNING: py:obj reference target not found: PyParser* build/NEWS:17517: WARNING: py:obj reference target not found: PyParser* build/NEWS:21743: WARNING: py:obj reference target not found: from tkinter import * build/NEWS:21948: WARNING: py:obj reference target not found: stdin build/NEWS:21948: WARNING: py:obj reference target not found: capture_output build/NEWS:21948: WARNING: py:obj reference target not found: stdout build/NEWS:21948: WARNING: py:obj reference target not found: stderr build/NEWS:21948: WARNING: py:obj reference target not found: **kwargs build/NEWS:22085: WARNING: py:obj reference target not found: ** build/NEWS:36314: WARNING: py:obj reference target not found: idlelib/*.py build/NEWS:36314: WARNING: py:obj reference target not found: idle_test/test_*.py 

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

Copy link
Member

@AlexWaygoodAlexWaygood left a comment

Choose a reason for hiding this comment

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

Great idea! A couple of comments:

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

@AlexWaygoodAlexWaygood left a comment

Choose a reason for hiding this comment

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

Thanks!

@hugovkhugovk merged commit 3531ea4 into python:mainDec 13, 2023
@hugovkhugovk deleted the docs-fix-sphinx-warnings-asterisks branch December 13, 2023 07:24
@miss-islington-app
Copy link

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

@bedevere-app
Copy link

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

@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 3531ea441b8b76bff90d2ecc062335da65fd3341 3.11 

@bedevere-appbedevere-appbot removed the needs backport to 3.12 only security fixes label Dec 13, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 13, 2023
…honGH-113029) (cherry picked from commit 3531ea4) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
hugovk added a commit to hugovk/cpython that referenced this pull request Dec 13, 2023
…ks (pythonGH-113029) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>. (cherry picked from commit 3531ea4) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-app
Copy link

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

@bedevere-appbedevere-appbot removed the needs backport to 3.11 only security fixes label Dec 13, 2023
AlexWaygood added a commit that referenced this pull request Dec 13, 2023
…-113029) (#113043) gh-101100: Fix Sphinx warning in references with asterisks (GH-113029) (cherry picked from commit 3531ea4) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@hugovk@AlexWaygood