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 in whatsnew/2.3.rst #112373

Merged
merged 2 commits into from
Dec 14, 2023
Merged

gh-101100: Fix Sphinx warnings in whatsnew/2.3.rst #112373

merged 2 commits into from
Dec 14, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Nov 24, 2023 •
edited by github-actions bot
Loading

Same rationale as #112351.

Fix 166 Sphinx warnings:

❯ SPHINXERRORHANDLING=-n PATH=./venv/bin:$PATH sphinx-build -b html -d build/doctrees -j auto -n . build/html whatsnew/2.3.rst 2>&1 | grep 2.3.rst | tee >(wc -l)
Doc/whatsnew/2.3.rst:43: WARNING: py:mod reference target not found: sets
Doc/whatsnew/2.3.rst:43: WARNING: py:class reference target not found: ImmutableSet
Doc/whatsnew/2.3.rst:43: WARNING: py:class reference target not found: ImmutableSet
Doc/whatsnew/2.3.rst:66: WARNING: py:meth reference target not found: union
Doc/whatsnew/2.3.rst:66: WARNING: py:meth reference target not found: intersection
Doc/whatsnew/2.3.rst:66: WARNING: py:meth reference target not found: union_update
Doc/whatsnew/2.3.rst:66: WARNING: py:meth reference target not found: intersection_update
Doc/whatsnew/2.3.rst:86: WARNING: py:meth reference target not found: symmetric_difference_update
Doc/whatsnew/2.3.rst:100: WARNING: py:meth reference target not found: issubset
Doc/whatsnew/2.3.rst:100: WARNING: py:meth reference target not found: issuperset
Doc/whatsnew/2.3.rst:169: WARNING: py:func reference target not found: generate_ints
Doc/whatsnew/2.3.rst:230: WARNING: py:func reference target not found: find
Doc/whatsnew/2.3.rst:344: WARNING: py:func reference target not found: os.getcwdu
Doc/whatsnew/2.3.rst:384: WARNING: py:meth reference target not found: read
Doc/whatsnew/2.3.rst:391: WARNING: py:func reference target not found: execfile
Doc/whatsnew/2.3.rst:453: WARNING: py:class reference target not found: Logger
Doc/whatsnew/2.3.rst:453: WARNING: py:class reference target not found: Logger
Doc/whatsnew/2.3.rst:453: WARNING: py:class reference target not found: Logger
Doc/whatsnew/2.3.rst:453: WARNING: py:class reference target not found: Logger
Doc/whatsnew/2.3.rst:453: WARNING: py:class reference target not found: Logger
Doc/whatsnew/2.3.rst:481: WARNING: py:meth reference target not found: setLevel
Doc/whatsnew/2.3.rst:486: WARNING: py:func reference target not found: warning
Doc/whatsnew/2.3.rst:490: WARNING: py:func reference target not found: exception
Doc/whatsnew/2.3.rst:519: WARNING: py:class reference target not found: Logger
Doc/whatsnew/2.3.rst:519: WARNING: py:attr reference target not found: propagate
Doc/whatsnew/2.3.rst:523: WARNING: py:class reference target not found: Logger
Doc/whatsnew/2.3.rst:523: WARNING: py:class reference target not found: LogRecord
Doc/whatsnew/2.3.rst:523: WARNING: py:class reference target not found: Handler
Doc/whatsnew/2.3.rst:523: WARNING: py:class reference target not found: LogRecord
Doc/whatsnew/2.3.rst:523: WARNING: py:class reference target not found: LogRecord
Doc/whatsnew/2.3.rst:523: WARNING: py:class reference target not found: Formatter
Doc/whatsnew/2.3.rst:552: WARNING: py:mod reference target not found: __builtin__
Doc/whatsnew/2.3.rst:664: WARNING: py:func reference target not found: setup
Doc/whatsnew/2.3.rst:705: WARNING: py:mod reference target not found: ihooks
Doc/whatsnew/2.3.rst:705: WARNING: py:mod reference target not found: imputil
Doc/whatsnew/2.3.rst:705: WARNING: py:mod reference target not found: iu
Doc/whatsnew/2.3.rst:712: WARNING: py:mod reference target not found: iu
Doc/whatsnew/2.3.rst:793: WARNING: py:func reference target not found: reader
Doc/whatsnew/2.3.rst:817: WARNING: py:mod reference target not found: cPickle
Doc/whatsnew/2.3.rst:830: WARNING: py:attr reference target not found: __safe_for_unpickling__
Doc/whatsnew/2.3.rst:836: WARNING: py:meth reference target not found: __getstate__
Doc/whatsnew/2.3.rst:836: WARNING: py:meth reference target not found: __setstate__
Doc/whatsnew/2.3.rst:836: WARNING: py:meth reference target not found: __getnewargs__
Doc/whatsnew/2.3.rst:939: WARNING: py:meth reference target not found: indices
Doc/whatsnew/2.3.rst:1044: WARNING: py:mod reference target not found: new
Doc/whatsnew/2.3.rst:1072: WARNING: py:meth reference target not found: xreadlines
Doc/whatsnew/2.3.rst:1072: WARNING: py:meth reference target not found: xreadlines
Doc/whatsnew/2.3.rst:1072: WARNING: py:attr reference target not found: encoding
Doc/whatsnew/2.3.rst:1093: WARNING: py:func reference target not found: sys.getcheckinterval
Doc/whatsnew/2.3.rst:1101: WARNING: py:attr reference target not found: __class__
Doc/whatsnew/2.3.rst:1140: WARNING: py:meth reference target not found: find
Doc/whatsnew/2.3.rst:1143: WARNING: py:meth reference target not found: strip
Doc/whatsnew/2.3.rst:1143: WARNING: py:meth reference target not found: lstrip
Doc/whatsnew/2.3.rst:1143: WARNING: py:meth reference target not found: rstrip
Doc/whatsnew/2.3.rst:1159: WARNING: py:meth reference target not found: startswith
Doc/whatsnew/2.3.rst:1159: WARNING: py:meth reference target not found: endswith
Doc/whatsnew/2.3.rst:1162: WARNING: py:meth reference target not found: zfill
Doc/whatsnew/2.3.rst:1162: WARNING: py:meth reference target not found: zfill
Doc/whatsnew/2.3.rst:1162: WARNING: py:meth reference target not found: zfill
Doc/whatsnew/2.3.rst:1176: WARNING: py:class reference target not found: basestring
Doc/whatsnew/2.3.rst:1176: WARNING: py:class reference target not found: basestring
Doc/whatsnew/2.3.rst:1194: WARNING: py:meth reference target not found: sort
Doc/whatsnew/2.3.rst:1206: WARNING: py:func reference target not found: xrange
Doc/whatsnew/2.3.rst:1233: WARNING: py:mod reference target not found: bsddb
Doc/whatsnew/2.3.rst:1237: WARNING: py:mod reference target not found: bsddb185
Doc/whatsnew/2.3.rst:1237: WARNING: py:mod reference target not found: bsddb
Doc/whatsnew/2.3.rst:1237: WARNING: py:mod reference target not found: bsddb3
Doc/whatsnew/2.3.rst:1237: WARNING: py:mod reference target not found: bsddb
Doc/whatsnew/2.3.rst:1256: WARNING: py:class reference target not found: Extension
Doc/whatsnew/2.3.rst:1256: WARNING: py:class reference target not found: Extension
Doc/whatsnew/2.3.rst:1270: WARNING: 'envvar' reference target not found: CPP
Doc/whatsnew/2.3.rst:1275: WARNING: py:func reference target not found: DocTestSuite
Doc/whatsnew/2.3.rst:1283: WARNING: py:func reference target not found: gnu_getopt
Doc/whatsnew/2.3.rst:1314: WARNING: py:func reference target not found: heappush
Doc/whatsnew/2.3.rst:1314: WARNING: py:func reference target not found: heappop
Doc/whatsnew/2.3.rst:1343: WARNING: py:func reference target not found: predicate
Doc/whatsnew/2.3.rst:1359: WARNING: py:func reference target not found: getpgid
Doc/whatsnew/2.3.rst:1359: WARNING: py:func reference target not found: killpg
Doc/whatsnew/2.3.rst:1359: WARNING: py:func reference target not found: lchown
Doc/whatsnew/2.3.rst:1359: WARNING: py:func reference target not found: loadavg
Doc/whatsnew/2.3.rst:1359: WARNING: py:func reference target not found: major
Doc/whatsnew/2.3.rst:1359: WARNING: py:func reference target not found: makedev
Doc/whatsnew/2.3.rst:1359: WARNING: py:func reference target not found: minor
Doc/whatsnew/2.3.rst:1359: WARNING: py:func reference target not found: mknod
Doc/whatsnew/2.3.rst:1365: WARNING: py:func reference target not found: *stat
Doc/whatsnew/2.3.rst:1369: WARNING: py:class reference target not found: stat_result
Doc/whatsnew/2.3.rst:1369: WARNING: py:func reference target not found: os.stat_float_times
Doc/whatsnew/2.3.rst:1394: WARNING: py:mod reference target not found: linuxaudiodev
Doc/whatsnew/2.3.rst:1405: WARNING: py:mod reference target not found: pyexpat
Doc/whatsnew/2.3.rst:1405: WARNING: py:attr reference target not found: buffer_text
Doc/whatsnew/2.3.rst:1410: WARNING: py:class reference target not found: xrange
Doc/whatsnew/2.3.rst:1410: WARNING: py:func reference target not found: sample
Doc/whatsnew/2.3.rst:1438: WARNING: py:func reference target not found: get_history_item
Doc/whatsnew/2.3.rst:1438: WARNING: py:func reference target not found: get_current_history_length
Doc/whatsnew/2.3.rst:1438: WARNING: py:func reference target not found: redisplay
Doc/whatsnew/2.3.rst:1442: WARNING: py:mod reference target not found: rexec
Doc/whatsnew/2.3.rst:1442: WARNING: py:mod reference target not found: Bastion
Doc/whatsnew/2.3.rst:1442: WARNING: py:mod reference target not found: rexec
Doc/whatsnew/2.3.rst:1442: WARNING: py:mod reference target not found: rexec
Doc/whatsnew/2.3.rst:1448: WARNING: py:mod reference target not found: rexec
Doc/whatsnew/2.3.rst:1448: WARNING: py:mod reference target not found: rexec
Doc/whatsnew/2.3.rst:1452: WARNING: py:mod reference target not found: rotor
Doc/whatsnew/2.3.rst:1477: WARNING: c:macro reference target not found: PYTHON_API_VERSION
Doc/whatsnew/2.3.rst:1477: WARNING: py:func reference target not found: sys.exc_clear
Doc/whatsnew/2.3.rst:1484: WARNING: py:func reference target not found: fill
Doc/whatsnew/2.3.rst:1484: WARNING: py:func reference target not found: wrap
Doc/whatsnew/2.3.rst:1506: WARNING: py:class reference target not found: TextWrapper
Doc/whatsnew/2.3.rst:1506: WARNING: py:class reference target not found: TextWrapper
Doc/whatsnew/2.3.rst:1506: WARNING: py:func reference target not found: wrap
Doc/whatsnew/2.3.rst:1506: WARNING: py:func reference target not found: fill
Doc/whatsnew/2.3.rst:1512: WARNING: py:mod reference target not found: thread
Doc/whatsnew/2.3.rst:1512: WARNING: py:mod reference target not found: dummy_thread
Doc/whatsnew/2.3.rst:1512: WARNING: py:mod reference target not found: dummy_threading
Doc/whatsnew/2.3.rst:1512: WARNING: py:mod reference target not found: thread
Doc/whatsnew/2.3.rst:1524: WARNING: py:mod reference target not found: _threading
Doc/whatsnew/2.3.rst:1524: WARNING: py:mod reference target not found: _threading
Doc/whatsnew/2.3.rst:1532: WARNING: py:func reference target not found: strptime
Doc/whatsnew/2.3.rst:1532: WARNING: py:func reference target not found: strptime
Doc/whatsnew/2.3.rst:1538: WARNING: py:class reference target not found: Timer
Doc/whatsnew/2.3.rst:1538: WARNING: py:func reference target not found: unicode
Doc/whatsnew/2.3.rst:1561: WARNING: py:mod reference target not found: Tkinter
Doc/whatsnew/2.3.rst:1561: WARNING: py:mod reference target not found: Tkinter
Doc/whatsnew/2.3.rst:1561: WARNING: py:mod reference target not found: Tkinter
Doc/whatsnew/2.3.rst:1572: WARNING: py:mod reference target not found: _tkinter
Doc/whatsnew/2.3.rst:1572: WARNING: py:class reference target not found: _tkinter.Tcl_Obj
Doc/whatsnew/2.3.rst:1572: WARNING: py:meth reference target not found: wantobjects
Doc/whatsnew/2.3.rst:1572: WARNING: py:class reference target not found: tkapp
Doc/whatsnew/2.3.rst:1578: WARNING: py:mod reference target not found: _tkinter
Doc/whatsnew/2.3.rst:1578: WARNING: py:mod reference target not found: Tkinter
Doc/whatsnew/2.3.rst:1583: WARNING: py:attr reference target not found: wantobjects
Doc/whatsnew/2.3.rst:1583: WARNING: py:mod reference target not found: Tkinter
Doc/whatsnew/2.3.rst:1583: WARNING: py:class reference target not found: tkapp
Doc/whatsnew/2.3.rst:1592: WARNING: py:mod reference target not found: UserDict
Doc/whatsnew/2.3.rst:1592: WARNING: py:class reference target not found: DictMixin
Doc/whatsnew/2.3.rst:1598: WARNING: py:meth reference target not found: __setitem__
Doc/whatsnew/2.3.rst:1598: WARNING: py:meth reference target not found: __delitem__
Doc/whatsnew/2.3.rst:1598: WARNING: py:meth reference target not found: keys
Doc/whatsnew/2.3.rst:1641: WARNING: py:meth reference target not found: toxml
Doc/whatsnew/2.3.rst:1641: WARNING: py:meth reference target not found: toprettyxml
Doc/whatsnew/2.3.rst:1645: WARNING: py:mod reference target not found: xmlrpclib
Doc/whatsnew/2.3.rst:1645: WARNING: py:class reference target not found: Marshaller
Doc/whatsnew/2.3.rst:1651: WARNING: py:mod reference target not found: DocXMLRPCServer
Doc/whatsnew/2.3.rst:1664: WARNING: py:mod reference target not found: httplib
Doc/whatsnew/2.3.rst:1664: WARNING: py:mod reference target not found: httplib
Doc/whatsnew/2.3.rst:1685: WARNING: py:class reference target not found: date
Doc/whatsnew/2.3.rst:1685: WARNING: py:class reference target not found: date
Doc/whatsnew/2.3.rst:1685: WARNING: py:class reference target not found: timedelta
Doc/whatsnew/2.3.rst:1685: WARNING: py:class reference target not found: tzinfo
Doc/whatsnew/2.3.rst:1692: WARNING: py:class reference target not found: date
Doc/whatsnew/2.3.rst:1692: WARNING: py:meth reference target not found: date.today
Doc/whatsnew/2.3.rst:1710: WARNING: py:meth reference target not found: replace
Doc/whatsnew/2.3.rst:1710: WARNING: py:class reference target not found: date
Doc/whatsnew/2.3.rst:1720: WARNING: py:meth reference target not found: isoformat
Doc/whatsnew/2.3.rst:1720: WARNING: py:class reference target not found: date
Doc/whatsnew/2.3.rst:1720: WARNING: py:class reference target not found: timedelta
Doc/whatsnew/2.3.rst:1720: WARNING: py:class reference target not found: date
Doc/whatsnew/2.3.rst:1742: WARNING: py:class reference target not found: OptionParser
Doc/whatsnew/2.3.rst:1756: WARNING: py:meth reference target not found: parse_args
Doc/whatsnew/2.3.rst:1927: WARNING: py:attr reference target not found: __module__
Doc/whatsnew/2.3.rst:1940: WARNING: py:func reference target not found: fork
Doc/whatsnew/2.3.rst:2001: WARNING: py:attr reference target not found: f_lineno
Doc/whatsnew/2.3.rst:2006: WARNING: py:attr reference target not found: f_lineno
Doc/whatsnew/2.3.rst:2034: WARNING: py:mod reference target not found: _tkinter
Doc/whatsnew/2.3.rst:2034: WARNING: py:class reference target not found: _tkinter.Tcl_Obj
Doc/whatsnew/2.3.rst:2052: WARNING: py:func reference target not found: setup
Doc/whatsnew/2.3.rst:2052: WARNING: py:func reference target not found: get_distutil_options
     166

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

@bedevere-app bedevere-app bot mentioned this pull request Nov 24, 2023
Open
@hugovk hugovk added skip news needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes docs Documentation in the Doc dir and removed awaiting core review labels Nov 24, 2023
@hugovk hugovk merged commit 961f104 into python:main Dec 14, 2023
25 checks passed
@hugovk hugovk deleted the docs-fix-sphinx-warnings-whatsnew-2.3 branch December 14, 2023 20:48
@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 961f1043a022ddeff314f63480a232335a598d6a 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 961f1043a022ddeff314f63480a232335a598d6a 3.11

@bedevere-app
Copy link

bedevere-app bot commented Dec 14, 2023

GH-113142 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 Dec 14, 2023
hugovk added a commit to hugovk/cpython that referenced this pull request Dec 14, 2023
@hugovk
[3.12] pythongh-101100: Fix Sphinx warnings in whatsnew/2.3.rst (py…
9e91e7e 
…thonGH-112373)

(cherry picked from commit 961f104)

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

bedevere-app bot commented Dec 14, 2023

GH-113143 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 Dec 14, 2023
hugovk added a commit to hugovk/cpython that referenced this pull request Dec 14, 2023
@hugovk
[3.11] pythongh-101100: Fix Sphinx warnings in whatsnew/2.3.rst (py…
eda3f04 
…thonGH-112373)

(cherry picked from commit 961f104)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Dec 14, 2023
@hugovk
[3.12] gh-101100: Fix Sphinx warnings in whatsnew/2.3.rst (GH-112373)…
2b08539 
… (#113142)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Dec 14, 2023
@hugovk
[3.11] gh-101100: Fix Sphinx warnings in whatsnew/2.3.rst (GH-112373)…
b8ad2e2 
… (#113143)
corona10 pushed a commit to corona10/cpython that referenced this pull request Dec 15, 2023
@hugovk @corona10
pythongh-101100: Fix Sphinx warnings in whatsnew/2.3.rst (python#11…
f64e3fa 
…2373)
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@hugovk @aisk
pythongh-101100: Fix Sphinx warnings in whatsnew/2.3.rst (python#11…
de43133 
…2373)
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@hugovk @Glyphack
pythongh-101100: Fix Sphinx warnings in whatsnew/2.3.rst (python#11…
04e11cc 
…2373)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@willingc willingc willingc 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 @willingc