之前有一篇博客介绍过 sphinx-doc 。出文档的时候，发现有个小伙伴弄了一大堆代码，而且阅读文档的人好像要手动复制去运行一下，查了下怎么加复制按钮，于是就用了 sphinx-copybutton 。怎么用呢？

什么是 sphinx-copybutton

https://github.com/choldgraf/sphinx-copybutton

pip install sphinx-copybutton

In your conf.py configuration file, add sphinx_copybutton to your extensions list. E.g.:

extensions = [
    ...
    'sphinx_copybutton'
    ...
]

问题

用了几天，发现打开文档的时候转半天 : (

https://github.com/choldgraf/sphinx-copybutton/issues/15

优化

这个时候可以这样优化。思路是把需要网络下载的东西提前下载好，放在 _static 文件夹下。下面是 step by step 的修改方法。

1，找到pip的目录

pip show sphinx-copybutton
cd ${location} # cd /home/XXX/.local/lib/python2.7/sit-packages

2.下载 css/js 到本地

cd sphinx_copybutton/_static
wget https://use.fontawesome.com/releases/v5.2.0/css/all.css &&\
 wget https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css &&\
 wget https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js &&\
 wget https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js &&\
 wget https://cdn.jsdelivr.net/npm/clipboard@1/dist/clipboard.min.js

chmod +x ./*

3. 更新 __init__.py

cd ..
vim __init__.py

其中 23-30 行修改为

app.add_stylesheet('copybutton.css')
app.add_stylesheet('all.css')
app.add_stylesheet('bootstrap.min.css')

app.add_javascript("copybutton.js")
app.add_javascript('clipboard.min.js')
app.add_javascript('popper.min.js')
app.add_javascript('bootstrap.min.js')

4. 按照之前的流程继续编译

make html

小结

本文介绍了在用 sphinx 输出文档的时候如何增加复制按钮。以及作者使用这个功能时发现的问题、对问题的绕过方法。

玩