👌 IMPROVE: Code block highlighting #478
Merged
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.
In markdown a code block (a.k.a fence) is of the form:
MyST-Parser mimics the
code-block
directive to render these blocks:In sphinx, the lexer name is only recorded as the
language
attribute,and the text is lexed later by pygments within the
visit_literal_block
method of the output format
SphinxTranslator
.This is the current logic.
However, in docutils, this directive directly parses the text with the pygments lexer, if syntax highlighting is enabled (the default). This was not handled.
Both cases are now handled, and additionally the following configuration are added:
myst_highlight_code_blocks
(docutils only): If True (default) use pygments to create lexical tokens for the given language, otherwise skip lexical analysismyst_number_code_blocks
: A list of languages to add line numbers to