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

Uploaded Source

Built Distribution

sphinx_copybutton-0.2.3-py2.py3-none-any.whl (8.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx-copybutton-0.2.3.tar.gz
Algorithm Hash digest
SHA256 0107d354618df8341c84e998178817db0b8a5e5fc7b175d2885a48f79a1cd202
MD5 633ce57162bf9b4c2e952eaddeae9014
BLAKE2b-256 2ae4872d9a33db68c95b8f7905e2a98caed347a9efa01cb7d8390637ee197ac6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_copybutton-0.2.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ff55e771b958657b1f940fb7c98793889a682e56c7a048d33aac677b4e2c4e95
MD5 a773519ea43d1017d4f1c20a2fcd0a16
BLAKE2b-256 3e30864a3587b843b6925111514905f5b1a6d896b7dd97ab82d249ede612ed75

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