doc: fix inline interpreted text without a role #1755
Merged
Conversation
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
sphinx became stricter when handling interpreted text without a role,
e.g. "`foo`" since [1], see [2]. This results in errors such as:
sphinx.errors.SphinxError: cannot determine default role!
In the past, heuristics were used to determine how
to format the text (inline code, italic, ..).
In labgrid, interpreted text without a role is used inconsistently. Most
times it was actually meant to be either inline code ("``foo``"), italic
text or links to docs sections or class definitions.
Fix all such occurrences with explicit variants that actually make sense
in their respective contexts.
[1] sphinx-doc/sphinx@114093c
[2] sphinx-doc/sphinx#13904
Signed-off-by: Bastian Krause <[email protected]>
sphinx became stricter when handling interpreted text without a role,
e.g. "`foo`" since [1], see [2]. This results in errors such as:
sphinx.errors.SphinxError: cannot determine default role!
In the past, heuristics were used to determine how
to format the text (inline code, italic, ..).
In labgrid, interpreted text without a role is used inconsistently. Most
times it was actually meant to be either inline code ("``foo``"), italic
text or links to docs sections or class definitions.
Fix all such occurrences with explicit variants that actually make sense
in their respective contexts.
[1] sphinx-doc/sphinx@114093c
[2] sphinx-doc/sphinx#13904
Signed-off-by: Bastian Krause <[email protected]>
sphinx became stricter when handling interpreted text without a role,
e.g. "`foo`" since [1], see [2]. This results in errors such as:
sphinx.errors.SphinxError: cannot determine default role!
In the past, heuristics were used to determine how
to format the text (inline code, italic, ..).
In labgrid, interpreted text without a role is used inconsistently. Most
times it was actually meant to be either inline code ("``foo``"), italic
text or links to docs sections or class definitions.
Fix all such occurrences with explicit variants that actually make sense
in their respective contexts.
[1] sphinx-doc/sphinx@114093c
[2] sphinx-doc/sphinx#13904
Signed-off-by: Bastian Krause <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1755 +/- ##
======================================
Coverage 45.4% 45.4%
======================================
Files 172 172
Lines 13503 13503
======================================
Hits 6131 6131
Misses 7372 7372
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Emantor
approved these changes
Oct 9, 2025
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.
Description
sphinx became stricter when handling interpreted text without a role,
e.g. `foo` since [1], see [2]. This results in errors such as:
In the past, heuristics were used to determine how to format the text (inline code, italic, ..).
In labgrid, interpreted text without a role is used inconsistently. Most times it was actually meant to be either inline code (``foo``), italic text or links to docs sections or class definitions. Fix all such occurrences with explicit variants that actually make sense in their respective contexts.
[1] sphinx-doc/sphinx@114093c
[2] sphinx-doc/sphinx#13904
Checklist