Add :hide_err: option to suppress [runpythonerror] from runpython output#56
Merged
Merged
Conversation
Agent-Logs-Url: https://github.com/sdpython/sphinx-runpython/sessions/398ae408-14c9-4d08-b0cf-259ba560c7bb Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add option to remove runpython error message
Add Apr 29, 2026
:hide_err: option to suppress [runpythonerror] from runpython output
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
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.
When using
.. runpython::with:rst:, any stderr output (deprecation warnings, etc.) causes[runpythonerror]to be literally appended to the RST content and rendered into the final documentation. There was no way to suppress this.Changes
:hide_err:flag option onRunPythonDirective— when present, skips appending the\n[runpythonerror]\n<stderr>block to the output contenttest_runpython_hide_errverifying the error block is suppressed while stdout is preservedUsage
Without
:hide_err:, theDeprecationWarningwould render as[runpythonerror]followed by the warning text in the output.