Remove `$`, `>>>` and other prompt prefixes when code copied from the… (#3884)

Adding configurations for sphinx-copybutton in conf.py
https://sphinx-copybutton.readthedocs.io/en/latest/use.html#using-regexp-prompt-identifiers

diff --git a/docs/conf.py b/docs/conf.py
index f7cf1b42842d6e51136f9bba3785c9b9d04f151a..6b6454353258fa2f051f872fec8efcaef173facf 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -210,6 +210,13 @@ epub_exclude_files = ["search.html"]
 
 autodoc_member_order = "bysource"
 
 
 autodoc_member_order = "bysource"
 

+#  -- sphinx-copybutton configuration ----------------------------------------
+copybutton_prompt_text = (
+    r">>> |\.\.\. |> |\$ |\# | In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
+)
+copybutton_prompt_is_regexp = True
+copybutton_remove_prompts = True
+

 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.