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.7.tar.gz (464.6 kB view details)

Uploaded Source

Built Distribution

sphinx_copybutton-0.2.7-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx-copybutton-0.2.7.tar.gz
  • Upload date:
  • Size: 464.6 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.7.tar.gz
Algorithm Hash digest
SHA256 98dd1c9c877b3529c6788efeb63c9f311b02f8acedf8195b7a65ee018c900489
MD5 38c014fa1d9d98fd686ba4f417ccbac4
BLAKE2b-256 859af6b0a53bc223b22999171da8921bb48bf948b44c7e5d42689d7c95c72f9d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_copybutton-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 9.4 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d8cdc70d0de293adfbbce8083a444e37dc084a44bb85e23204ce07a0d1803bea
MD5 4d8773d3552420fcded7d64901bfded7
BLAKE2b-256 4d2bb8ee43f0cbb84524048e1083932bd8653ef33925b7ea89a4ca2d2ec3e719

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