Skip to main content

A small sphinx extension to add "copy" buttons to code blocks.

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

Uploaded Source

Built Distribution

sphinx_copybutton-0.2.4-py2.py3-none-any.whl (9.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: sphinx-copybutton-0.2.4.tar.gz
  • Upload date:
  • Size: 105.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.19.1

File hashes

Hashes for sphinx-copybutton-0.2.4.tar.gz
Algorithm Hash digest
SHA256 88d7425a886c180e0beda170e716bc98f169c2f52c40189d1173c06d7cdc82af
MD5 a1c742ab21992b32995348de7c8f41ae
BLAKE2b-256 0b771c4e7b4d9f4b3c6c2f34335b8bfa9f192e460828124f4f0b772051ed6be7

See more details on using hashes here.

File details

Details for the file sphinx_copybutton-0.2.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_copybutton-0.2.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1300423332decde2c5e15b14c0fab3d4d0fb395a42fbe395186b66bd69095689
MD5 432674875a2d8053f6de5caa71a0ac8e
BLAKE2b-256 14862af5ab92178a557c391aa5bc14408bce6cfb5051f0ecf0909614920a0da0

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