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

Uploaded Source

Built Distribution

sphinx_copybutton-0.2.5-py2.py3-none-any.whl (9.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx-copybutton-0.2.5.tar.gz
Algorithm Hash digest
SHA256 94593d9fd7318fa119ae4144fc99a91cb5cd4523adb363b6a93ee9b2ad0160ae
MD5 57916ca00977d5d489d6d2fdd9e9511e
BLAKE2b-256 f7f50b3a9d9fdf722eb3e523a9bd987db3592a24815ebba63a2a4b9ee951628f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_copybutton-0.2.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 313c7114c9b2020c6bc12420925fbee5e3af76cde89945089f34579ad158478a
MD5 a6a0cc26a94c7ccc4c9a686e88e57461
BLAKE2b-256 cf82808b3f6ac27664076e6159f94772a08df6ccb10893e7f87ff167a5e55bf2

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