◐ Shell
reader mode source ↗
Skip to content

gh-101100: Fix Sphinx warnings in library/configparser.rst#113598

Merged
hugovk merged 2 commits into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-configparser
Dec 31, 2023
Merged

gh-101100: Fix Sphinx warnings in library/configparser.rst#113598
hugovk merged 2 commits into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-configparser

Conversation

@hugovk

@hugovk hugovk commented Dec 31, 2023 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Member

Fix 14 warnings in library/configparser.rst and 20 configparser-related warnings elsewhere:

build/NEWS:10797: WARNING: py:class reference target not found: configparser.Interpolation
build/NEWS:13368: WARNING: py:attr reference target not found: filename
build/NEWS:13368: WARNING: py:class reference target not found: ConfigParser
build/NEWS:13368: WARNING: py:class reference target not found: ParsingError
build/NEWS:13368: WARNING: py:class reference target not found: SafeConfigParser
build/NEWS:13368: WARNING: py:meth reference target not found: readfp
build/NEWS:26630: WARNING: py:obj reference target not found: ConfigParser.items()
Doc/library/configparser.rst:211: WARNING: py:meth reference target not found: get
Doc/library/configparser.rst:235: WARNING: py:meth reference target not found: get
Doc/library/configparser.rst:483: WARNING: py:meth reference target not found: __init__
Doc/library/configparser.rst:493: WARNING: py:meth reference target not found: read_dict
Doc/library/configparser.rst:637: WARNING: py:meth reference target not found: read_dict
Doc/library/configparser.rst:637: WARNING: py:meth reference target not found: read_file
Doc/library/configparser.rst:637: WARNING: py:meth reference target not found: read_string
Doc/library/configparser.rst:694: WARNING: py:meth reference target not found: getdecimal
Doc/library/configparser.rst:1064: WARNING: py:attr reference target not found: name
Doc/library/configparser.rst:1069: WARNING: py:meth reference target not found: readfp
Doc/library/configparser.rst:1217: WARNING: py:meth reference target not found: get
Doc/library/configparser.rst:1290: WARNING: py:meth reference target not found: add_section
Doc/library/configparser.rst:1295: WARNING: py:meth reference target not found: __init__
Doc/library/configparser.rst:1349: WARNING: py:meth reference target not found: __init__
Doc/library/logging.config.rst:94: WARNING: py:class reference target not found: configparser.Configparser
Doc/whatsnew/2.0.rst:1031: WARNING: py:mod reference target not found: ConfigParser
Doc/whatsnew/2.4.rst:1055: WARNING: py:meth reference target not found: read
Doc/whatsnew/2.4.rst:1055: WARNING: py:mod reference target not found: ConfigParser
Doc/whatsnew/2.7.rst:290: WARNING: py:mod reference target not found: ConfigParser
Doc/whatsnew/2.7.rst:1137: WARNING: py:mod reference target not found: ConfigParser
Doc/whatsnew/3.2.rst:184: WARNING: py:mod reference target not found: ConfigParser
Doc/whatsnew/3.2.rst:2135: WARNING: py:class reference target not found: ConfigParser
Doc/whatsnew/3.2.rst:2135: WARNING: py:class reference target not found: SafeConfigParser
Doc/whatsnew/3.2.rst:2411: WARNING: py:class reference target not found: ConfigParser
Doc/whatsnew/3.2.rst:2616: WARNING: py:class reference target not found: ConfigParser
Doc/whatsnew/3.2.rst:2616: WARNING: py:class reference target not found: SafeConfigParser
Doc/whatsnew/3.11.rst:1776: WARNING: py:meth reference target not found: configparser.RawConfigParser.readfp

@hugovk hugovk requested a review from vsajip as a code owner December 31, 2023 17:11
@hugovk hugovk changed the title Fix Sphinx warnings in library/configparser.rst Dec 31, 2023
@bedevere-app bedevere-app Bot mentioned this pull request Dec 31, 2023
Open
@hugovk hugovk added docs Documentation in the Doc dir skip news needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Dec 31, 2023
AlexWaygood
AlexWaygood approved these changes Dec 31, 2023
View reviewed changes

@AlexWaygood AlexWaygood left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

Looks great!

@hugovk @AlexWaygood
Refer to builtin.vars …
a864a98 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@hugovk hugovk merged commit 30a6d79 into python:main Dec 31, 2023
@hugovk hugovk deleted the docs-fix-sphinx-warnings-configparser branch December 31, 2023 17:57
@miss-islington-app

miss-islington-app Bot commented Dec 31, 2023

Copy link
Copy Markdown

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

@miss-islington-app

miss-islington-app Bot commented Dec 31, 2023

Copy link
Copy Markdown

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 30a6d79fb8bc1ef96600c290c016720103b74b2d 3.12

@miss-islington-app

miss-islington-app Bot commented Dec 31, 2023

Copy link
Copy Markdown

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 30a6d79fb8bc1ef96600c290c016720103b74b2d 3.11

@bedevere-app

bedevere-app Bot commented Dec 31, 2023

Copy link
Copy Markdown

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Dec 31, 2023
hugovk added a commit to hugovk/cpython that referenced this pull request Dec 31, 2023
@hugovk @AlexWaygood
[3.12] pythongh-101100: Fix Sphinx warnings in `library/configparser.… …
84b7d87 
…rst` (pythonGH-113598)

(cherry picked from commit 30a6d79)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-app

bedevere-app Bot commented Dec 31, 2023

Copy link
Copy Markdown

GH-113600 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 31, 2023
hugovk added a commit to hugovk/cpython that referenced this pull request Dec 31, 2023
@hugovk @AlexWaygood
[3.11] pythongh-101100: Fix Sphinx warnings in `library/configparser.… …
fcd0b38 
…rst` (pythonGH-113598)

(cherry picked from commit 30a6d79)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood added a commit that referenced this pull request Dec 31, 2023
@hugovk @AlexWaygood
[3.12] gh-101100: Fix Sphinx warnings in library/configparser.rst (G… …
a8011d5 
…H-113598) (#113599)

(cherry picked from commit 30a6d79)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood added a commit that referenced this pull request Dec 31, 2023
@hugovk @AlexWaygood
[3.11] gh-101100: Fix Sphinx warnings in library/configparser.rst (G… …
5169113 
…H-113598) (#113600)

(cherry picked from commit 30a6d79)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
kulikjak pushed a commit to kulikjak/cpython that referenced this pull request Jan 22, 2024
@hugovk @AlexWaygood @kulikjak
pythongh-101100: Fix Sphinx warnings in library/configparser.rst (p… …
6eef764 
…ython#113598)

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 in library/configparser.rst (p… …
499bc7c 
…ython#113598)

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 in library/configparser.rst (p… …
215ee93 
…ython#113598)

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

@vsajip vsajip Awaiting requested review from vsajip vsajip is a code owner

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