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.

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

Uploaded Source

Built Distribution

sphinx_copybutton-0.2.1-py2.py3-none-any.whl (8.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx-copybutton-0.2.1.tar.gz
Algorithm Hash digest
SHA256 1ee9d87d312844280161138b7002c09c3d87f5585bab76d283403cc7f5fa2ed4
MD5 81c53d12439b3681e66a81ac4d9f2404
BLAKE2b-256 a6fade94056a6a493c4b021b0ffbda3eb65af9bddb3e3f5fc7ebd30207be3413

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_copybutton-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 213150a5dd8c1e8713e8fe0e0f47735864617714cafb6ce2233ff7ac618df3ae
MD5 4ab59b25a2a5fb7f2ea329129e7f4730
BLAKE2b-256 38014aa38c6bdddce232bb7f34416d38e1fb99b7f4054f840c50f34108d5da49

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