Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
docs: add the copybutton extension to sphinx
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Mon, 24 Jan 2022 13:55:14 +0000 (14:55 +0100)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Mon, 24 Jan 2022 14:02:28 +0000 (15:02 +0100)
docs/requirements.txt
docs/source/conf.py

index d00e05a..2d4f477 100644 (file)
@@ -3,6 +3,7 @@ sphinx>=3.4.3,<4.0
 sphinx_rtd_theme>=0.5.2
 # sphinx_tabs v1.2.1 is required for Sphinx 2
 sphinx_tabs>=1.2.1
+sphinx_copybutton
 javalang
 beautifulsoup4
 lxml
index 966f3fa..ee7c971 100644 (file)
@@ -54,6 +54,7 @@ extensions = [
     'sphinx.ext.intersphinx',
     'sphinx.ext.autosummary',
     'sphinx_tabs.tabs',
+    'sphinx_copybutton',
     'javasphinx',
     'showfile',
 ]
@@ -64,6 +65,10 @@ todo_include_todos = True
 breathe_projects = {'simgrid': '../build/xml'}
 breathe_default_project = "simgrid"
 
+# Setup the copybutton extension
+copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
+copybutton_prompt_is_regexp = True
+
 # Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found
 nitpicky = True
 nitpick_ignore = [