Configure sphinx-copybutton to strip prompts (#11702)

Nikhil-Ladha · web-flow · commit 5c61b2a52c3b · 2023-03-27T16:23:02.000+01:00
diff --git a/docs/html/conf.py b/docs/html/conf.py
@@ -131,3 +131,9 @@ def to_document_name(path: str, base_dir: str) -> str:
 
 
 man_pages = determine_man_pages()
+
+# -- Options for sphinx_copybutton ----------------------------------------------------
+
+copybutton_prompt_text = r"\$ | C\:\> "
+copybutton_prompt_is_regexp = True
+copybutton_only_copy_prompt_lines = False
diff --git a/news/11702.trivial.rst b/news/11702.trivial.rst
@@ -0,0 +1,2 @@
+Strip command line prompts like "$" and "C:>" from the actual command
+being copied using the copybutton.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Strip command line prompts like "$" and "C:>" from the actual command`
	`2`	`+being copied using the copybutton.`