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

Uploaded Source

Built Distribution

sphinx_copybutton-0.2.2-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.2.tar.gz.

File metadata

  • Download URL: sphinx-copybutton-0.2.2.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.2.tar.gz
Algorithm Hash digest
SHA256 1277d9ed56987325c4b39c6865dd99a45d9b384c125b4061a1c1ad1a16efadfc
MD5 de002c5213ad4576c31f890855d318d2
BLAKE2b-256 7f967cd9a87569e05b4d9a6bde0ee60788cca2a03c5d3b26b3ed2f548b582e92

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_copybutton-0.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8fd43ed21059f529dc41da44471ef8e9ec810d06cdd6079319865321e9c3ffe7
MD5 d72cff8c8075cafd4b6fb6020496bd22
BLAKE2b-256 665ff94c740d7789b5e7033b44bd84336045aa66070f240b6c240124ca0e26ce

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