Repository navigation
Fix decorator cross-reference titles in docs - #159270
Closed
Marwan-verse wants to merge 2 commits into
Closed
Marwan-verse wants to merge 2 commits into
Marwan-verse wants to merge 2 commits into
Conversation
Marwan-verse
requested review from
AA-Turner,
ethanfurman,
rhettinger and
willingc
as code owners
October 12, 2026 21:47
|
The following commit authors need to sign the Contributor License Agreement: |
bedevere-app
Bot
added
awaiting review
docs
Documentation build overview
17 files changed ·
|
Member
|
Sorry but this was premature, please wait till an action is decided on the issue. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix the Sphinx 8 decorator-role title bug reported in #159265. The role adds
@before processing~, so affected references render as@~module.name.Replace the 29 affected short-form references across 17 documentation files with explicit display titles. This preserves the intended short decorator names and fixes the rendering without changing the pinned Sphinx version.
Closes #159265.
AI disclosure: Prepared with OpenAI Codex.
Validation: The documentation build was not run locally; CI will check the docs.