Skip to content

feat: strip "$ " shell prompts from copy button #341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iamsharduld merged 1 commit into from
May 12, 2026
Merged

feat: strip "$ " shell prompts from copy button #341

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,15 @@

mathjax_path = 'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js'

# Configure sphinx-copybutton (auto-enabled by canonical_sphinx) to strip
# the "$ " shell prompt from copied content. In code blocks that contain
# prompts, only the prompted lines (commands) are copied; output lines are
# skipped. Code blocks without any prompts (e.g. JSON output) are unaffected
# and copy verbatim.
copybutton_prompt_text = r"\$ "
copybutton_prompt_is_regexp = True
copybutton_line_continuation_character = "\\"

# Excludes files or directories from processing

exclude_patterns = [
Expand Down
Loading