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

Uploaded Source

Built Distribution

sphinx_copybutton-0.2.10.dev0-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-copybutton-0.2.10.dev0.tar.gz.

File metadata

  • Download URL: sphinx-copybutton-0.2.10.dev0.tar.gz
  • Upload date:
  • Size: 111.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/42.0.1.post20191125 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.8.0

File hashes

Hashes for sphinx-copybutton-0.2.10.dev0.tar.gz
Algorithm Hash digest
SHA256 d36fa8fd9c928097b5016abe1fdc388de71445e6dd9fecfc422b25236f570234
MD5 560ca9c28d1753d4f94aecd1cef115ac
BLAKE2b-256 a54b733df8b4237b750d057c08b29c873c33d375b0a5cb98c810e3a442460039

See more details on using hashes here.

File details

Details for the file sphinx_copybutton-0.2.10.dev0-py3-none-any.whl.

File metadata

  • Download URL: sphinx_copybutton-0.2.10.dev0-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/42.0.1.post20191125 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.8.0

File hashes

Hashes for sphinx_copybutton-0.2.10.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 332c34087f50e48f5cc83efd51a4112f07d3416c15bcf79976ffcf022b49dcc8
MD5 becc2da925be32af25955a058b125b99
BLAKE2b-256 ab08246c1a2956bf39e0167a8d56552f062f161faa31fbf06f3f70948e2b72f2

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