Add copy button for code in docs (#489)

akihironitta · web-flow · commit fc7c7c362d01 · 2025-01-18T14:42:40.000Z
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -20,6 +20,7 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.napoleon',
     'sphinx.ext.viewcode',
+    'sphinx_copybutton',
     'pyg',
 ]
 
@@ -45,6 +46,9 @@
     'xgboost': ('https://xgboost.readthedocs.io/en/stable/', None),
 }
 
+copybutton_prompt_text = r">>> |\.\.\. "
+copybutton_prompt_is_regexp = True
+
 
 def setup(app):
     def rst_jinja_render(app, _, source):

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@`
`20`	`20`	`'sphinx.ext.mathjax',`
`21`	`21`	`'sphinx.ext.napoleon',`
`22`	`22`	`'sphinx.ext.viewcode',`
	`23`	`+ 'sphinx_copybutton',`
`23`	`24`	`'pyg',`
`24`	`25`	`]`
`25`	`26`
`@@ -45,6 +46,9 @@`
`45`	`46`	`'xgboost': ('https://xgboost.readthedocs.io/en/stable/', None),`
`46`	`47`	`}`
`47`	`48`
	`49`	`+copybutton_prompt_text = r">>> \|\.\.\. "`
	`50`	`+copybutton_prompt_is_regexp = True`
	`51`	`+`
`48`	`52`
`49`	`53`	`def setup(app):`
`50`	`54`	`def rst_jinja_render(app, _, source):`