sphinx-copybutton
A small sphinx extension to add a "copy" button to code blocks.
See the sphinx-copybutton documentation for more details!
Installation
You can install sphinx-copybutton with pip:
pip install sphinx-copybutton
Or with conda via conda-forge:
conda install -c conda-forge sphinx-copybutton
Usage
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!
Customization
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
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.
Acknowledgements
Many thanks to the excellent clipboard.js library for the lightweight javascript code that powers the copy button!
Release files for sphinx-copybutton 0.5.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx-copybutton-0.5.2.tar.gz | 23.0 kB | Without provenance | Details for sphinx-copybutton-0.5.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_copybutton-0.5.2-py3-none-any.whl | Python 3 | none | any | Details for sphinx_copybutton-0.5.2-py3-none-any.whl |
Total release size: 36.4 kB
Security for sphinx-copybutton 0.5.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
