Add support for lexer examples. #2451
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
This adds support for a new attribute `_example` which, if present, will load the file under `tests/examplefiles` pointed to by `_example` and show it as part of the lexer documentation. This allows us to have unit-tested files show up as small code snippets in the documentation, without having to worry that the documentation output contains possibly incorrectly highlighted code.
jeanas
reviewed
Jun 9, 2023
jeanas
approved these changes
Jun 9, 2023
Also tweak the style a bit so code snippets in admonitions look acceptable.
Member
|
👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds support for a new attribute
_examplewhich, if present, willload the file under
tests/examplefilespointed to by_exampleandshow it as part of the lexer documentation. This allows us to have
unit-tested files show up as small code snippets in the documentation,
without having to worry that the documentation output contains possibly
incorrectly highlighted code.
This would allow #2442 to use this machinery instead of embedding the snippets as "plain code" into the doc string.