| 
|
A small sphinx extension to add a "copy" button to code blocks.
See the sphinx-copybutton documentation for more details!
You can install sphinx-copybutton with pip:
pip install sphinx-copybutton
Or with conda via conda-forge:
conda install -c conda-forge sphinx-copybutton
In your conf.py configuration file, add sphinx_copybutton to your extensions list.
E.g.:
extensions = [
...
'sphinx_copybutton'
...
]
When you build your site, your code blocks should now have little copy buttons to their right. Clicking the button will copy the code inside!
If you'd like to customize the look of the copy buttons, you can over-write any of the CSS rules specified in the Sphinx-CopyButton CSS file (link)
Development should principally adhere to the EBP Developer Conventions
Sphinx-Copybutton is hosted on the pypi repository. After a release - following the EBP release instructions - confirm that the new version of Sphinx-Copybutton is posted to pypi.
Many thanks to the excellent clipboard.js library for the lightweight javascript code that powers the copy button!
FAQs
Add a copy button to each of your code cells.
We found that sphinx-copybutton demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.