Merge pull request #463 from matthewfeickert/docs/add-sphinx-copybutton

docs: Add sphinx-copybutton support
ssl-hep · Sep 19, 2024 · bf9fc7a · bf9fc7a
2 parents c555974 + 933c474
commit bf9fc7a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -27,7 +27,8 @@
     'code_include.extension',
     'myst_parser',
     'sphinxcontrib.autodoc_pydantic',
-    'sphinx_tabs.tabs'
+    'sphinx_tabs.tabs',
+    'sphinx_copybutton',
 ]
 
 templates_path = ['_templates']
@@ -50,3 +51,8 @@
 
 html_theme = 'furo'
 html_static_path = ['_static']
+
+# sphinx-copybutton configuration
+copybutton_prompt_text = r">>> |\.\.\. |\$ "
+copybutton_prompt_is_regexp = True
+copybutton_here_doc_delimiter = "EOF"
diff --git a/pyproject.toml b/pyproject.toml
@@ -86,7 +86,8 @@ docs = [
     "myst-parser>=3.0.1",
     "func-adl-servicex-xaodr22",
     "autodoc-pydantic==2.2.0",
-    "sphinx-tabs>=3.4.5"
+    "sphinx-tabs>=3.4.5",
+    "sphinx-copybutton>=0.5.2",
 ]
 develop = [
     "servicex[test,docs]",