gh-101100: Fix Sphinx warnings in `whatsnew/3.2.rst` by hugovk · Pull Request #115580 · python/cpython · GitHub

Fix 49 warnings:

Doc/whatsnew/3.2.rst:345: WARNING: py:class reference target not found: importlib.abc.PyLoader
Doc/whatsnew/3.2.rst:345: WARNING: py:class reference target not found: importlib.abc.PyPycLoader
Doc/whatsnew/3.2.rst:400: WARNING: py:func reference target not found: start_response
Doc/whatsnew/3.2.rst:418: WARNING: py:meth reference target not found: write
Doc/whatsnew/3.2.rst:418: WARNING: py:func reference target not found: start_response
Doc/whatsnew/3.2.rst:500: WARNING: py:meth reference target not found: __getattr__
Doc/whatsnew/3.2.rst:500: WARNING: py:meth reference target not found: __getattribute__
Doc/whatsnew/3.2.rst:621: WARNING: py:class reference target not found: collections.Sequence
Doc/whatsnew/3.2.rst:723: WARNING: py:mod reference target not found: xml.etree.cElementTree
Doc/whatsnew/3.2.rst:1010: WARNING: py:data reference target not found: time.accept2dyear
Doc/whatsnew/3.2.rst:1015: WARNING: py:data reference target not found: time.accept2dyear
Doc/whatsnew/3.2.rst:1034: WARNING: py:data reference target not found: time.accept2dyear
Doc/whatsnew/3.2.rst:1151: WARNING: py:meth reference target not found: __repr__
Doc/whatsnew/3.2.rst:1157: WARNING: py:meth reference target not found: __repr__
Doc/whatsnew/3.2.rst:1157: WARNING: py:meth reference target not found: __repr__
Doc/whatsnew/3.2.rst:1338: WARNING: py:attr reference target not found: Context.clamp
Doc/whatsnew/3.2.rst:1431: WARNING: py:class reference target not found: zipfile.ZipExtFile
Doc/whatsnew/3.2.rst:1599: WARNING: py:attr reference target not found: sqlite3.Connection.in_transit
Doc/whatsnew/3.2.rst:1646: WARNING: py:func reference target not found: ssl.match_hostname
Doc/whatsnew/3.2.rst:1650: WARNING: py:func reference target not found: ssl.wrap_socket
Doc/whatsnew/3.2.rst:1761: WARNING: py:class reference target not found: unittest.case.TestCase
Doc/whatsnew/3.2.rst:1799: WARNING: py:meth reference target not found: unittest.TestCase.assertRegexpMatches
Doc/whatsnew/3.2.rst:1816: WARNING: py:meth reference target not found: assert_
Doc/whatsnew/3.2.rst:1817: WARNING: py:meth reference target not found: assertEquals
Doc/whatsnew/3.2.rst:1818: WARNING: py:meth reference target not found: assertNotEquals
Doc/whatsnew/3.2.rst:1819: WARNING: py:meth reference target not found: assertAlmostEquals
Doc/whatsnew/3.2.rst:1820: WARNING: py:meth reference target not found: assertNotAlmostEquals
Doc/whatsnew/3.2.rst:1827: WARNING: py:meth reference target not found: unittest.TestCase.assertDictContainsSubset
Doc/whatsnew/3.2.rst:2000: WARNING: py:meth reference target not found: get
Doc/whatsnew/3.2.rst:2000: WARNING: py:meth reference target not found: setdefault
Doc/whatsnew/3.2.rst:2121: WARNING: py:class reference target not found: Pdb
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: split
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: rsplit
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: splitlines
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: replace
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: rfind
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: rindex
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: rsplit
Doc/whatsnew/3.2.rst:2397: WARNING: py:meth reference target not found: rpartition
Doc/whatsnew/3.2.rst:2411: WARNING: py:meth reference target not found: array.repeat
Doc/whatsnew/3.2.rst:2411: WARNING: py:class reference target not found: BaseHTTPRequestHandler
Doc/whatsnew/3.2.rst:2565: WARNING: c:macro reference target not found: Py_VA_COPY
Doc/whatsnew/3.2.rst:2569: WARNING: c:func reference target not found: PySys_SetArgvEx
Doc/whatsnew/3.2.rst:2653: WARNING: py:meth reference target not found: array.tostring
Doc/whatsnew/3.2.rst:2653: WARNING: py:meth reference target not found: array.fromstring
Doc/whatsnew/3.2.rst:2653: WARNING: py:meth reference target not found: array.tobytes
Doc/whatsnew/3.2.rst:2653: WARNING: py:meth reference target not found: array.frombytes
Doc/whatsnew/3.2.rst:2667: WARNING: py:func reference target not found: sys.setfilesystemencoding
Doc/whatsnew/3.2.rst:2675: WARNING: py:func reference target not found: string.maketrans

Issue: Fix all Sphinx reference warnings in the documentation #101100

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

Nice! Just one question:

Public... but apparently still undocumented? Should this maybe be left as is, and added to this list for now?

cpython/Doc/conf.py

Lines 273 to 279 in 318f219

    
               # Attributes/methods/etc. that definitely should be documented better, 
        
               # but are deferred for now: 
        
               ('py:attr', '__annotations__'), 
        
               ('py:meth', '__missing__'), 
        
               ('py:attr', '__wrapped__'), 
        
               ('py:meth', 'index'),  # list.index, tuple.index, etc. 
        
           ]

Sure, added!

Thanks!

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

…115580) (cherry picked from commit 4dff48d) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

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

…115580) (cherry picked from commit 4dff48d) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

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

… (#115589) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

… (#115590) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

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

Fix Sphinx warnings in whatsnew/3.2.rst

37efff7

bedevere-app Bot added awaiting core review docs Documentation in the Doc dir skip news labels Feb 16, 2024

bedevere-app Bot mentioned this pull request Feb 16, 2024

Fix all Sphinx reference warnings in the documentation #101100

Closed

hugovk added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Feb 16, 2024

AlexWaygood approved these changes Feb 16, 2024

View reviewed changes

bedevere-app Bot added awaiting merge and removed awaiting core review labels Feb 16, 2024

hugovk and others added 2 commits February 17, 2024 11:47

Add decimal.Context.clamp to nitpick_ignore

6395059

Merge branch 'main' into docs-fix-sphinx-warnings-3.2

0e2b322

AlexWaygood approved these changes Feb 17, 2024

View reviewed changes

hugovk merged commit 4dff48d into python:main Feb 17, 2024

hugovk deleted the docs-fix-sphinx-warnings-3.2 branch February 17, 2024 10:03

bedevere-app Bot removed the awaiting merge label Feb 17, 2024

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Feb 17, 2024

bedevere-app Bot removed the needs backport to 3.11 only security fixes label Feb 17, 2024

hugovk added a commit that referenced this pull request Feb 17, 2024

[3.12] gh-101100 : Fix Sphinx warnings in whatsnew/3.2.rst (GH-115580 )…

2763f38

… (#115589) 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 17, 2024

[3.11] gh-101100 : Fix Sphinx warnings in whatsnew/3.2.rst (GH-115580 )…

b87a443

… (#115590) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

woodruffw pushed a commit to woodruffw-forks/cpython that referenced this pull request Mar 4, 2024

pythongh-101100 : Fix Sphinx warnings in whatsnew/3.2.rst (python#11…

779b7b9

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

diegorusso pushed a commit to diegorusso/cpython that referenced this pull request Apr 17, 2024

pythongh-101100 : Fix Sphinx warnings in whatsnew/3.2.rst (python#11…

3acb68e

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

LukasWoodtli pushed a commit to LukasWoodtli/cpython that referenced this pull request Jan 22, 2025

pythongh-101100 : Fix Sphinx warnings in whatsnew/3.2.rst (python#11…

c82fe70

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

gh-101100: Fix Sphinx warnings in `whatsnew/3.2.rst` by hugovk · Pull Request #115580 · python/cpython · GitHub

Repository navigation

gh-101100: Fix Sphinx warnings in whatsnew/3.2.rst - #115580

gh-101100: Fix Sphinx warnings in whatsnew/3.2.rst#115580
hugovk merged 3 commits into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-3.2

hugovk commented Feb 16, 2024 •
edited by github-actions Bot
Loading

Uh oh!

Uh oh!

AlexWaygood left a comment

Uh oh!

AlexWaygood Feb 16, 2024

Uh oh!

hugovk Feb 17, 2024

Uh oh!

AlexWaygood left a comment

Uh oh!

miss-islington-app Bot commented Feb 17, 2024

Uh oh!

bedevere-app Bot commented Feb 17, 2024

Uh oh!

bedevere-app Bot commented Feb 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

               Another useful change for the :mod:`decimal` module is that the
-              :attr:`Context.clamp` attribute is now public.  This is useful in creating
+              :attr:`Context.clamp <decimal.Context>` attribute is now public.  This is useful in creating

	# Attributes/methods/etc. that definitely should be documented better,
	# but are deferred for now:
	('py:attr', '__annotations__'),
	('py:meth', '__missing__'),
	('py:attr', '__wrapped__'),
	('py:meth', 'index'), # list.index, tuple.index, etc.
	]

gh-101100: Fix Sphinx warnings in `whatsnew/3.2.rst` by hugovk · Pull Request #115580 · python/cpython · GitHub

Repository navigation

gh-101100: Fix Sphinx warnings in whatsnew/3.2.rst - #115580

gh-101100: Fix Sphinx warnings in whatsnew/3.2.rst#115580hugovk merged 3 commits intopython:mainpython/cpython:mainfrom hugovk:docs-fix-sphinx-warnings-3.2hugovk/cpython:docs-fix-sphinx-warnings-3.2Copy head branch name to clipboard

Conversation

hugovk commented Feb 16, 2024 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AlexWaygood left a comment

Choose a reason for hiding this comment

Uh oh!

AlexWaygood Feb 16, 2024

Choose a reason for hiding this comment

Uh oh!

hugovk Feb 17, 2024

Choose a reason for hiding this comment

Uh oh!

AlexWaygood left a comment

Choose a reason for hiding this comment

Uh oh!

miss-islington-app Bot commented Feb 17, 2024

Uh oh!

bedevere-app Bot commented Feb 17, 2024

Uh oh!

bedevere-app Bot commented Feb 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

gh-101100: Fix Sphinx warnings in whatsnew/3.2.rst#115580
hugovk merged 3 commits into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-3.2

hugovk commented Feb 16, 2024 •
edited by github-actions Bot
Loading