docs: Use sphinx-copybutton prompt regex to fully capture examples (#…

…1617) * Add copybutton_prompt_text regex support to allow for the prompt character to be `>>>`, `$`, or `...` to handle newlines - c.f. https://sphinx-copybutton.readthedocs.io/en/latest/#strip-and-configure-input-prompts-for-code-cells * Add support for HERE-document syntax with $ prompt * Update minimum required version of sphinx-copybutton to v0.3.2 to ensure HERE-document support
scikit-hep · Oct 6, 2021 · 7ecaa63 · 7ecaa63
1 parent 6db5223
commit 7ecaa63
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -325,7 +325,9 @@ def setup(app):
 htmlhelp_basename = 'pyhfdoc'
 
 # sphinx-copybutton configuration
-copybutton_prompt_text = ">>> "
+copybutton_prompt_text = r">>> |\.\.\. |\$ "
+copybutton_prompt_is_regexp = True
+copybutton_here_doc_delimiter = "EOF"
 
 # -- Options for LaTeX output ---------------------------------------------
 

diff --git a/setup.py b/setup.py
@@ -55,7 +55,7 @@
             'nbsphinx',
             'ipywidgets',
             'sphinx-issues',
-            'sphinx-copybutton>0.2.9',
+            'sphinx-copybutton>=0.3.2',
         ]
     )
 )