为您的每个代码单元格添加复制按钮。
项目描述
sphinx-copybutton
一个小的Sphinx扩展,用于在代码块中添加“复制”按钮。
查看更多详细信息,请参阅 sphinx-copybutton 文档!
安装
您可以使用 pip
安装 sphinx-copybutton
pip install sphinx-copybutton
或者通过 conda
通过 conda-forge
安装
conda install -c conda-forge sphinx-copybutton
使用方法
在您的 conf.py
配置文件中,将 sphinx_copybutton
添加到您的扩展列表中。例如。
extensions = [
...
'sphinx_copybutton'
...
]
当您构建您的站点时,您的代码块现在应该在其右侧有小的复制按钮。点击按钮将复制其中的代码!
自定义
如果您想自定义复制按钮的外观,您可以在 Sphinx-CopyButton CSS 文件(链接)中覆盖任何指定的CSS规则。
开发
开发应主要遵守 EBP 开发约定
Sphinx-Copybutton 在 pypi 存储库 上托管。发布后 - 遵循 EBP 发布说明 - 确认新的 Sphinx-Copybutton 版本已发布到 pypi。
致谢
非常感谢优秀的clipboard.js库,它提供的轻量级JavaScript代码为复制按钮提供了动力!
项目详情
下载文件
下载适合您平台的文件。如果您不确定该选择哪个,请了解更多关于安装包的信息。
源代码分发
sphinx-copybutton-0.5.2.tar.gz (23.0 kB 查看哈希值)