feat: strip "$ " shell prompts from copy button#335
Open
iamsharduld wants to merge 1 commit intotrack/2from
Open
feat: strip "$ " shell prompts from copy button#335iamsharduld wants to merge 1 commit intotrack/2from
iamsharduld wants to merge 1 commit intotrack/2from
Conversation
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.
Issue
Copying a
$ commandblock from our docs pastes the$along with it, which then fails when run in a real shell. Affects every shell code block across the site.Solution
Adds two lines to
docs/conf.pyconfiguringsphinx-copybuttonto strip the$prompt on copy. Also setscopybutton_line_continuation_character = "\\"so multi-line commands joined by\copy as a single command.Checklist
Context
sphinx-copybutton(auto-enabled bycanonical_sphinx) supports prompt-stripping but doesn't apply it by default. Withcopybutton_prompt_text = r"\$ "andcopybutton_prompt_is_regexp = True, blocks containing$-prefixed lines copy only the command portion, and blocks without prompts (e.g. JSON output) copy verbatim.Aligns with the [Canonical Documentation Style Guide](https://docs.ubuntu.com/styleguide/en/), which advises against prompt marks in code samples for this exact reason.
Testing Instructions
cd docs && make clean && make serve$shell block, click the copy button.commandnot$ command.Upgrade Notes
None — additive config-only change. No content or build-pipeline changes.