Skip to content

gh-105812: Make use of the Sphinx deco role in documentation - #139598

Merged
JelleZijlstra merged 4 commits into
python:mainfrom
Viicos:deco-role-pt1
Jun 3, 2026
Merged

gh-105812: Make use of the Sphinx deco role in documentation#139598
JelleZijlstra merged 4 commits into
python:mainfrom
Viicos:deco-role-pt1

Conversation

@Viicos

@ViicosViicos commented Oct 5, 2025•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

For the following decorators: classmethod, staticmethod, property, ABC decorators, enum decorators, functools.lru_cache, functools.cache.

Note that depending on the context, I left references as :func: or :class:, for instance when it is reference as "the <...> object/function/descriptor".

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

@Viicos
pythongh-105812: Make use of the Sphinxdecorole in documentation,…
ed67875
… part 1
For the following decorators: `classmethod`, `staticmethod`,
`property`, ABC decorators, enum decorators, `functools.lru_cache`,
`functools.cache`.
@bedevere-appbedevere-appBot added docs Documentation in the Doc dir skip news labels Oct 5, 2025
@bedevere-appbedevere-appBot mentioned this pull request Oct 5, 2025
Closed
@AA-Turner

AA-Turner commented Oct 5, 2025

Copy link
Copy Markdown
Member

If this is 'part 1', what are the expected follow-up changes?

A

@Viicos

Viicos commented Oct 5, 2025

Copy link
Copy Markdown
ContributorAuthor

If this is 'part 1', what are the expected follow-up changes?

I'll comment on the original issue the remaining ones. Let me know if this is fine to tackle everything in a single PR.

@AA-Turner

AA-Turner commented Oct 5, 2025

Copy link
Copy Markdown
Member

Let me know if this is fine to tackle everything in a single PR.

I'd prefer one PR to review, as long as the diff stays reasonable.

A

@rhettinger
rhettinger removed their request for review October 6, 2025 07:08
@Viicos

Viicos commented Oct 25, 2025

Copy link
Copy Markdown
ContributorAuthor

@AA-Turner I migrated the remaining decorators.

@github-actions

github-actionsBot commented Apr 30, 2026

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

@github-actionsgithub-actionsBot added the stale Stale PR or inactive for long period of time. label Apr 30, 2026
JelleZijlstra
JelleZijlstra reviewed Jun 3, 2026
View reviewed changes
Comment threadDoc/whatsnew/2.5.rst Outdated
JelleZijlstra
JelleZijlstra approved these changes Jun 3, 2026
View reviewed changes

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

Looks good but this now has merge conflicts.

@ViicosViicos changed the title gh-105812: Make use of the Sphinx deco role in documentation, part 1gh-105812: Make use of the Sphinx deco role in documentationJun 3, 2026
@Viicos

Viicos commented Jun 3, 2026

Copy link
Copy Markdown
ContributorAuthor

Merged main to resolve conflicts.

@JelleZijlstra
JelleZijlstra enabled auto-merge (squash) June 3, 2026 13:09
@JelleZijlstra
JelleZijlstra merged commit deb33ec into python:mainJun 3, 2026
29 of 30 checks passed
@github-project-automationgithub-project-automationBot moved this from Todo to Done in Docs PRsJun 3, 2026
philthompson10 pushed a commit to philthompson10/cpython that referenced this pull request Jun 17, 2026
@Viicos@philthompson10
pythongh-105812: Make use of the Sphinxdecorole in documentation (p…
2872c95
…ython#139598)
@StanFromIrelandStanFromIreland mentioned this pull request Jul 30, 2026
Merged
@StanFromIrelandStanFromIreland added the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Jul 30, 2026
@miss-islington-app

miss-islington-appBot commented Jul 30, 2026

Copy link
Copy Markdown

Thanks @Viicos for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖

@miss-islington-app

miss-islington-appBot commented Jul 30, 2026

Copy link
Copy Markdown

Sorry, @Viicos and @JelleZijlstra, I could not cleanly backport this to 3.15 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker deb33ecba34c5c113626d9cd89e51d8708afc0c7 3.15

@StanFromIrelandStanFromIreland removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Jul 30, 2026
@bedevere-app

bedevere-appBot commented Jul 31, 2026

Copy link
Copy Markdown

GH-154979 is a backport of this pull request to the 3.15 branch.

@hugovkhugovk added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jul 31, 2026
@miss-islington-app

miss-islington-appBot commented Jul 31, 2026

Copy link
Copy Markdown

Thanks @Viicos for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app

miss-islington-appBot commented Jul 31, 2026

Copy link
Copy Markdown

Thanks @Viicos for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

@miss-islington-app

miss-islington-appBot commented Jul 31, 2026

Copy link
Copy Markdown

Sorry, @Viicos and @JelleZijlstra, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker deb33ecba34c5c113626d9cd89e51d8708afc0c7 3.13

@miss-islington-app

miss-islington-appBot commented Jul 31, 2026

Copy link
Copy Markdown

Sorry, @Viicos and @JelleZijlstra, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker deb33ecba34c5c113626d9cd89e51d8708afc0c7 3.14

@bedevere-app

bedevere-appBot commented Jul 31, 2026

Copy link
Copy Markdown

GH-154980 is a backport of this pull request to the 3.14 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.14 bugs and security fixes label Jul 31, 2026
@bedevere-app

bedevere-appBot commented Jul 31, 2026

Copy link
Copy Markdown

GH-154983 is a backport of this pull request to the 3.13 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.13 bugs and security fixes label Jul 31, 2026
hugovk added a commit that referenced this pull request Jul 31, 2026
@hugovk@Viicos
[3.15]gh-105812: Make use of the Sphinxdecorole in documentation (…
b3bfeae
…GH-139598) (#154979)
Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
hugovk added a commit that referenced this pull request Jul 31, 2026
@hugovk@Viicos
[3.14]gh-105812: Make use of the Sphinxdecorole in documentation (…
9e65465
…GH-139598) (#154980)
Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
hugovk added a commit that referenced this pull request Jul 31, 2026
@hugovk@Viicos
[3.13]gh-105812: Make use of the Sphinxdecorole in documentation (…
1e577e1
…GH-139598) (#154983)
Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JelleZijlstraJelleZijlstraJelleZijlstra approved these changes
@ethanfurmanethanfurmanAwaiting requested review from ethanfurmanethanfurman is a code owner
@AA-TurnerAA-TurnerAwaiting requested review from AA-TurnerAA-Turner is a code owner
@willingcwillingcAwaiting requested review from willingcwillingc is a code owner
@AlexWaygoodAlexWaygoodAwaiting requested review from AlexWaygoodAlexWaygood is a code owner
@ZeroIntensityZeroIntensityAwaiting requested review from ZeroIntensityZeroIntensity is a code owner

Assignees

@JelleZijlstraJelleZijlstra

Labels

docsDocumentation in the Doc dirskip newsstaleStale PR or inactive for long period of time.

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@Viicos@AA-Turner@JelleZijlstra@hugovk@StanFromIreland@nazeerali4325-commits