Skip to content

gh-101100: Fix Sphinx warnings in library/calendar.rst #113500

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 27, 2023
Merged

gh-101100: Fix Sphinx warnings in library/calendar.rst #113500

merged 2 commits into from
Dec 27, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Dec 26, 2023 •
edited by github-actions bot
Loading

Fix these five warnings:

  • the first by documenting it
  • the next two each refer to methods of two subclasses, so it's not obvious which subclass (or superclass)'s methods to link to, so just silence with !
  • the last two by including the relevant class in the link
Doc/library/calendar.rst:232: WARNING: py:meth reference target not found: formatmonthname
Doc/library/calendar.rst:292: WARNING: py:meth reference target not found: formatweekday
Doc/library/calendar.rst:292: WARNING: py:meth reference target not found: formatmonthname
Doc/library/calendar.rst:361: WARNING: py:meth reference target not found: formatmonth
Doc/library/calendar.rst:372: WARNING: py:meth reference target not found: formatyear

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

@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 26, 2023
@bedevere-app bedevere-app bot mentioned this pull request Dec 26, 2023
Open
serhiy-storchaka
serhiy-storchaka approved these changes Dec 27, 2023
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

LGTM.

@hugovk hugovk enabled auto-merge (squash) December 27, 2023 09:28
@hugovk hugovk merged commit fb02b66 into python:main Dec 27, 2023
@hugovk hugovk deleted the docs-fix-sphinx-warnings-calendar branch December 27, 2023 09:36
@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 fb02b6696002fc3dedbcf7c58aa40301650936ba 3.12

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 27, 2023
@hugovk @miss-islington
pythongh-101100: Fix Sphinx warnings in library/calendar.rst (pytho…
a63487a 
…nGH-113500)

(cherry picked from commit fb02b66)

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

bedevere-app bot commented Dec 27, 2023

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

bedevere-app bot commented Dec 27, 2023

GH-113509 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 27, 2023
hugovk added a commit to hugovk/cpython that referenced this pull request Dec 27, 2023
@hugovk
[3.12] pythongh-101100: Fix Sphinx warnings in library/calendar.rst (…
11e2508 
…pythonGH-113500)

(cherry picked from commit fb02b66)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Dec 27, 2023
@miss-islington @hugovk
[3.11] gh-101100: Fix Sphinx warnings in library/calendar.rst (GH-1…
e095f37 
…13500) (#113508)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Dec 27, 2023
@hugovk
[3.12] gh-101100: Fix Sphinx warnings in library/calendar.rst (GH-1…
11fd024 
…13500) (#113509)
kulikjak pushed a commit to kulikjak/cpython that referenced this pull request Jan 22, 2024
@hugovk @kulikjak
pythongh-101100: Fix Sphinx warnings in library/calendar.rst (pytho…
ec48309 
…n#113500)
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@hugovk @aisk
pythongh-101100: Fix Sphinx warnings in library/calendar.rst (pytho…
158e2ab 
…n#113500)
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@hugovk @Glyphack
pythongh-101100: Fix Sphinx warnings in library/calendar.rst (pytho…
4c7e254 
…n#113500)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka 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 @serhiy-storchaka