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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx-copybutton-0.2.7.dev0.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.dev0.tar.gz
Algorithm Hash digest
SHA256 8c51a34940dd6b601755496621297fd4a71499e8bf5b2851f5614f673374fbb7
MD5 987a30da1973bd4b64c98a68766d6211
BLAKE2b-256 635fda5129e896a96bcbca6da5cb57d92497fa95fcf880ccd02195c263da7bc5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_copybutton-0.2.7.dev0-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.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 804d821b914b94887291e35e3dfe00fb3cfc61fdf1b3917689e160ab56b442be
MD5 de9712d8580c8779b0ea6a8d1d7417b7
BLAKE2b-256 8453e2e49ffa056462385f1ed0fc9aad05007c1f0c48ee84d4ef931c9c1a6a0a

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