Skip to content

gh-101100: Fix Sphinx warnings in library/pyclbr.rst - #113739

Merged
hugovk merged 5 commits into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-pyclbr
Jan 5, 2024
Merged

gh-101100: Fix Sphinx warnings in library/pyclbr.rst#113739
hugovk merged 5 commits into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-pyclbr

Conversation

@hugovk

@hugovk hugovk commented Jan 5, 2024

Copy link
Copy Markdown
Member

Fix 6 warnings:

Doc/library/pyclbr.rst:61: WARNING: py:class reference target not found: Function
Doc/library/pyclbr.rst:111: WARNING: py:class reference target not found: Class
Doc/library/pyclbr.rst:152: WARNING: py:class reference target not found: Class
Doc/library/pyclbr.rst:152: WARNING: py:class reference target not found: Class
Doc/whatsnew/3.10.rst:1318: WARNING: py:func reference target not found: pyclbr.readline
Doc/whatsnew/3.10.rst:1318: WARNING: py:func reference target not found: pyclbr.readline_ex

First four fixed by adding the ..class: targets.

@AlexWaygood I think you're going to ask me to also add ! to these Function and Class refs because they appear inside the actual classes?

The last two look like typos (added in #24348) for readmodule and readmodule_ex that are documented and exist in https://github.com/python/cpython/blob/main/Lib/pyclbr.py


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

@AlexWaygood

Copy link
Copy Markdown
Member

@AlexWaygood I think you're going to ask me to also add ! to these Function and Class refs because they appear inside the actual classes?

Yes please! :D

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

A couple more cleanups we could do along the way:

Comment thread Doc/library/pyclbr.rst Outdated
Comment thread Doc/library/pyclbr.rst Outdated
Comment thread Doc/library/pyclbr.rst Outdated
Comment thread Doc/library/pyclbr.rst Outdated
Comment thread Doc/library/pyclbr.rst Outdated
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@hugovk
hugovk enabled auto-merge (squash) January 5, 2024 19:13
@hugovk
hugovk merged commit eb53750 into python:main Jan 5, 2024
@hugovk
hugovk deleted the docs-fix-sphinx-warnings-pyclbr branch January 5, 2024 19:15
@miss-islington-app

Copy link
Copy Markdown

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 5, 2024
…H-113739)

(cherry picked from commit eb53750)

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

bedevere-app Bot commented Jan 5, 2024

Copy link
Copy Markdown

GH-113748 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 Jan 5, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 5, 2024
…H-113739)

(cherry picked from commit eb53750)

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

bedevere-app Bot commented Jan 5, 2024

Copy link
Copy Markdown

GH-113749 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 Jan 5, 2024
hugovk added a commit that referenced this pull request Jan 5, 2024
) (#113748)


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 Jan 5, 2024
) (#113749)


Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
kulikjak pushed a commit to kulikjak/cpython that referenced this pull request Jan 22, 2024
…113739)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
…113739)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
…113739)

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

Labels

docs Documentation in the Doc dir skip news

2 participants