Repository navigation
Map Sphinx admonition classes so warnings convert to MyST - #99
Open
BetterAndBetterII wants to merge 2 commits into
Open
BetterAndBetterII wants to merge 2 commits into
BetterAndBetterII wants to merge 2 commits into
Conversation
Sphinx replaced docutils admonition directive classes, so the default conversion map missed them and fell back to eval-rst. Fixes executablebooks#97.
for more information, see https://pre-commit.ci
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
1 participant
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.
Summary
With Sphinx enabled (the default),
.. warning::and the other standard admonitions were wrapped in{eval-rst}instead of becoming MyST admonition directives.Sphinx 8.2+ registers its own classes under
sphinx.directives.admonitions.*. The conversion map only listed the olderdocutils.parsers.rst.directives.admonitions.*paths, so those directives fell through toeval_rst.Fix
Add matching
parse_content/parse_allentries for the Sphinx admonition classes (includingSeeAlso).Test
tests/test_admonitions.pyinjects a Sphinx-module-pathWarningstand-in and asserts the MyST{warning}form (not{eval-rst}).Fixes #97