Strip ANSI escape sequences from Sphinx directive output#15192
Open
damesei wants to merge 1 commit into
Open
Conversation
Fixes ipython#11424. When IPython's Sphinx directive executes code blocks, stderr/stdout and tracebacks can contain raw ANSI escape sequences that appear as garbled text in HTML/PDF documentation output. This adds a regex-based ANSI stripping step to process_input in EmbeddedSphinxShell so escape codes are removed before output reaches the rendered documentation. Also adds unit tests for the stripping behavior.
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.
Fixes #11424
The IPython Sphinx directive can produce output containing raw ANSI escape
sequences (e.g. color codes from tracebacks), which render as garbled text
in HTML/PDF docs. This PR strips those escape codes from processed_output
in EmbeddedSphinxShell.process_input using a compiled regex before the
output reaches the final rendered documentation.
Changes: