Sphinx-copybutton#
Sphinx-copybutton 只做一件事：在你的代码块右侧添加一个小的“复制”按钮。就是这样！它是轻量级的包装器，围绕着优秀的（同样轻量级的）JavaScript 库 ClipboardJS。
以下是示例
这里是代码块，注意右侧的复制按钮！
copy me!
如果代码块超出了文本区域的右侧，你可以直接点击按钮来获取全部内容。
123456789123456789123456789123456789123456789123456789123456789123456789123456789123456789123456789123456789123456789123456789123456789123456789123456789123456789
你可以配置 sphinx-copybutton 来检测代码单元格中的 输入提示，然后在复制之前移除这些提示，并跳过 不 以提示开头的行（以防它们是输出行）。
例如，本网站已配置为去除 Python 提示符（>>>）和输出行。试试复制粘贴下面的代码块。
>>> a = 2
>>> print(a)
2
>>>
>>> b = 'wow'
>>> print(b)
wow
安装#
你可以使用 pip 安装 sphinx-copybutton：
pip install sphinx-copybutton
或者通过 conda-forge 安装 conda：
conda install -c conda-forge sphinx-copybutton
这里 是 sphinx-copybutton 的 GitHub 仓库。
使用#
在您的 conf.py 配置文件中，将 sphinx_copybutton 添加到您的扩展列表。例如：
extensions = [
...
'sphinx_copybutton'
...
]
当你构建你的网站时，你的代码块应该现在有一个小的“复制”按钮了。点击按钮就可以复制代码了！
查阅 使用与自定义 了解更多关于如何使用 sphinx-copybutton 的信息。
灵感#
sphinx-copybutton 的 UI 和设计元素受到了 GitHub 的设计选择 的启发。使用的图标来自 Tabler 的图标集。