Doc: Tune docs#1228
Merged
Merged
Conversation
bjoernricks
approved these changes
Jun 15, 2026
This gets rid of Sphinx warning "Inline emphasis start-string without end-string" and keeps Sphinx from trying to link it to anchor id1 (which does not exist).
This gets rid of Sphinx errors/warnings "Unexpected indentation" and "Definition list ends without a blank line; unexpected unindent".
bjoernricks
approved these changes
Jun 15, 2026
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
3 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.
What
Tweak formatting and escaping in pydoc.
Why
To make Sphinx do as expected without complaints.
References