Skip to content

gh-101100: Fix Sphinx warnings in library/ast.rst #113289

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
Merged
merged 2 commits into from
Dec 19, 2023
Merged

gh-101100: Fix Sphinx warnings in library/ast.rst #113289

merged 2 commits into from
Dec 19, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Dec 19, 2023 •
edited
Loading

Fix 29 Sphinx warnings:

Doc/library/ast.rst:46: WARNING: py:mod reference target not found: _ast
Doc/library/ast.rst:131: WARNING: py:class reference target not found: ast.Num
Doc/library/ast.rst:131: WARNING: py:class reference target not found: ast.Str
Doc/library/ast.rst:131: WARNING: py:class reference target not found: ast.Bytes
Doc/library/ast.rst:131: WARNING: py:class reference target not found: ast.NameConstant
Doc/library/ast.rst:131: WARNING: py:class reference target not found: ast.Ellipsis
Doc/library/ast.rst:138: WARNING: py:class reference target not found: ast.Index
Doc/library/ast.rst:138: WARNING: py:class reference target not found: ast.ExtSlice
Doc/library/ast.rst:1937: WARNING: py:class reference target not found: Str
Doc/library/ast.rst:2288: WARNING: py:attr reference target not found: lineno
Doc/library/ast.rst:2288: WARNING: py:attr reference target not found: end_lineno
Doc/library/ast.rst:2288: WARNING: py:attr reference target not found: col_offset
Doc/library/ast.rst:2288: WARNING: py:attr reference target not found: end_col_offset
Doc/library/ast.rst:2300: WARNING: py:attr reference target not found: lineno
Doc/library/ast.rst:2300: WARNING: py:attr reference target not found: col_offset
Doc/library/ast.rst:2316: WARNING: py:attr reference target not found: lineno
Doc/library/ast.rst:2316: WARNING: py:attr reference target not found: col_offset
Doc/library/ast.rst:2316: WARNING: py:attr reference target not found: end_lineno
Doc/library/ast.rst:2316: WARNING: py:attr reference target not found: end_col_offset
Doc/library/ast.rst:2369: WARNING: py:meth reference target not found: visit_Num
Doc/library/ast.rst:2369: WARNING: py:meth reference target not found: visit_Str
Doc/library/ast.rst:2369: WARNING: py:meth reference target not found: visit_Bytes
Doc/library/ast.rst:2369: WARNING: py:meth reference target not found: visit_NameConstant
Doc/library/ast.rst:2369: WARNING: py:meth reference target not found: visit_Ellipsis
Doc/library/ast.rst:2369: WARNING: py:meth reference target not found: visit_Constant
Doc/library/ast.rst:2398: WARNING: py:meth reference target not found: generic_visit
Doc/library/ast.rst:2406: WARNING: py:attr reference target not found: lineno
Doc/whatsnew/3.8.rst:1673: WARNING: py:meth reference target not found: ast.NodeVisitor.visit_Constant
build/NEWS:21687: WARNING: py:meth reference target not found: ast.NodeVisitor.visit_Constant

These 14 remain:

Doc/library/ast.rst:51: WARNING: py:class reference target not found: ast.stmt
Doc/library/ast.rst:51: WARNING: py:class reference target not found: ast.expr
Doc/library/ast.rst:51: WARNING: py:class reference target not found: ast.expr
Doc/library/ast.rst:67: WARNING: py:attr reference target not found: left
Doc/library/ast.rst:67: WARNING: py:class reference target not found: ast.expr
Doc/library/ast.rst:82: WARNING: py:class reference target not found: ast.expr
Doc/library/ast.rst:82: WARNING: py:class reference target not found: ast.stmt
Doc/library/ast.rst:96: WARNING: py:class reference target not found: ast.T
Doc/library/ast.rst:98: WARNING: py:attr reference target not found: T._fields
Doc/library/ast.rst:2149: WARNING: py:class reference target not found: ast.operator
Doc/library/ast.rst:2149: WARNING: py:class reference target not found: ast.unaryop
Doc/library/ast.rst:2149: WARNING: py:class reference target not found: ast.cmpop
Doc/library/ast.rst:2149: WARNING: py:class reference target not found: ast.boolop
Doc/library/ast.rst:2149: WARNING: py:class reference target not found: ast.expr_context

📚 Documentation preview 📚: https://cpython-previews--113289.org.readthedocs.build/library/ast.html

@hugovk hugovk added docs Documentation in the Doc dir needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Dec 19, 2023
@bedevere-app bedevere-app bot mentioned this pull request Dec 19, 2023
Open
AlexWaygood
AlexWaygood approved these changes Dec 19, 2023
View reviewed changes
@hugovk @AlexWaygood
;
b6b5062 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@hugovk hugovk enabled auto-merge (squash) December 19, 2023 15:37
@hugovk hugovk merged commit 76bef38 into python:main Dec 19, 2023
@hugovk hugovk deleted the docs-fix-sphinx-warnings-ast branch December 19, 2023 15:44
@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 76bef3832bae64664882e27ecb6f89800a12cf43 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 76bef3832bae64664882e27ecb6f89800a12cf43 3.11

@bedevere-app
Copy link

bedevere-app bot commented Dec 19, 2023

GH-113290 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 19, 2023
@bedevere-app
Copy link

bedevere-app bot commented Dec 19, 2023

GH-113291 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 19, 2023
hugovk added a commit to hugovk/cpython that referenced this pull request Dec 19, 2023
@hugovk
[3.12] pythongh-101100: Fix Sphinx warnings in library/ast.rst (pyt…
3222e46 
…honGH-113289)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit 76bef38)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit to hugovk/cpython that referenced this pull request Dec 19, 2023
@hugovk
[3.11] pythongh-101100: Fix Sphinx warnings in library/ast.rst (pyt…
2a8338e 
…honGH-113289)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit 76bef38)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Dec 19, 2023
@hugovk
[3.12] gh-101100: Fix Sphinx warnings in library/ast.rst (GH-113289) (
72bbd88 
#113290)
hugovk added a commit that referenced this pull request Dec 19, 2023
@hugovk
[3.11] gh-101100: Fix Sphinx warnings in library/ast.rst (GH-113289) (
182676b 
#113291)
ryan-duve pushed a commit to ryan-duve/cpython that referenced this pull request Dec 26, 2023
@hugovk @AlexWaygood @ryan-duve
pythongh-101100: Fix Sphinx warnings in library/ast.rst (python#113289
8431169 
)

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/ast.rst (python#113289
1ec3623 
)

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/ast.rst (python#113289
7b48fca 
)

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

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