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)

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.

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

Uploaded Source

Built Distribution

sphinx_copybutton-0.3.0-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx-copybutton-0.3.0.tar.gz
  • Upload date:
  • Size: 112.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.8

File hashes

Hashes for sphinx-copybutton-0.3.0.tar.gz
Algorithm Hash digest
SHA256 4becad3a1e7c50211f1477e34fd4b6d027680e1612f497cb5b88cf85bccddaaa
MD5 bbe862ff11eddfe893066c30ba76ae68
BLAKE2b-256 417890feb86c96ab6227530fd1c32f549a5eb5447c77f30842a5e2d61b917c3d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_copybutton-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 11.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.8

File hashes

Hashes for sphinx_copybutton-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4cd06afd0588aa43eba968bfc6105e1ec6546c50a51f880af1d89afaebc6fb58
MD5 ce35c85f2182feb720359b4637f25ecc
BLAKE2b-256 eaf982e0040dbe208b976441dfad6a6ba1de380aef50537ac5e0694d8812216c

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