Skip to main content

Add a copy button to each of your code cells.

Project description

sphinx-copybutton

PyPI | Documentation

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

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)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-copybutton-0.2.9.tar.gz (473.8 kB view details)

Uploaded Source

Built Distribution

sphinx_copybutton-0.2.9-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-copybutton-0.2.9.tar.gz.

File metadata

  • Download URL: sphinx-copybutton-0.2.9.tar.gz
  • Upload date:
  • Size: 473.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0.post20191029 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for sphinx-copybutton-0.2.9.tar.gz
Algorithm Hash digest
SHA256 26d1f8e17a5290966179ec72536ee5224cc06e43325ffcb302b124ba20e93863
MD5 32feaf61cd4e7f8d629dc685ce0b8b6f
BLAKE2b-256 1127c0b949120424afaa732bf983e2242b97e7b82c9af88580fd91ce72654ff1

See more details on using hashes here.

File details

Details for the file sphinx_copybutton-0.2.9-py3-none-any.whl.

File metadata

  • Download URL: sphinx_copybutton-0.2.9-py3-none-any.whl
  • Upload date:
  • Size: 12.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0.post20191029 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for sphinx_copybutton-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 8a6e1df10e911dd0e42bb8e5b8dcee99dd24c21eff58be1862f8ac42268be034
MD5 2ff57408c84f574ff251dbc63f65d098
BLAKE2b-256 85891e9d8cc5f735814b600167051d35acc5b719fa2651c6e957f14740a257b4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page