# sphinx-copybutton

> Add a copy button to each of your code cells.

- **URL**: https://www.freshcrate.ai/projects/sphinx-copybutton
- **Author**: Executable Book Project
- **Category**: Frameworks
- **Latest version**: `0.5.2` (2026-04-21)
- **License**: MIT License
- **Source**: https://github.com/executablebooks/sphinx-copybutton
- **Language**: JavaScript
- **GitHub**: 268 stars, 58 forks
- **Registry**: pypi (`sphinx-copybutton`)
- **Tags**: `pypi`

## Description

# sphinx-copybutton

[![PyPI](https://img.shields.io/pypi/v/sphinx-copybutton.svg)](https://pypi.org/project/sphinx_copybutton/) | [![Conda Version](https://img.shields.io/conda/vn/conda-forge/sphinx-copybutton.svg)](https://anaconda.org/conda-forge/sphinx-copybutton) | [![Documentation](https://readthedocs.org/projects/sphinx-copybutton/badge/?version=latest)](https://sphinx-copybutton.readthedocs.io/en/latest/?badge=latest)

A small sphinx extension to add a "copy" button to code blocks.

See [the sphinx-copybutton documentation](https://sphinx-copybutton.readthedocs.io/en/latest/) for more details!

![Copy Button Demo](https://user-images.githubusercontent.com/1839645/150200219-73663c59-08fd-4185-b157-62f3769c02ac.gif)

## Installation

You can install `sphinx-copybutton` with `pip`:

```bash
pip install sphinx-copybutton
```

Or with `conda` via `conda-forge`:

```bash
conda install -c conda-forge sphinx-copybutton
```


## Usage

In your `conf.py` configuration file, add `sphinx_copybutton` to your extensions list.
E.g.:

```python
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](sphinx_copybutton/_static/copybutton.css))

## Development

Development should principally adhere to the [EBP Developer Conventions](https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md)

Sphinx-Copybutton is [hosted on the pypi repository](https://pypi.org/project/sphinx-copybutton/).
After a release - following the [EBP release instructions](https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md#releases-and-change-logs) - confirm that the new version of Sphinx-Copybutton [is posted to pypi](https://pypi.org/project/sphinx-copybutton/).

## Acknowledgements

Many thanks to the excellent [clipboard.js library](https://clipboardjs.com/) for the lightweight javascript code that powers the copy button!

## Recent releases

| Version | Date | Urgency | Changes |
| --- | --- | --- | --- |
| `0.5.2` | 2026-04-21 | Low | Imported from PyPI (0.5.2) |
| `v0.5.2` | 2023-04-14 | Low | ## v0.5.2 - 2022-11-15  ([full changelog](https://github.com/executablebooks/sphinx-copybutton/compare/v0.5.1...v0.5.2))   - BUG: Don't exclude `.gp` class by default.  This made excluding prompts more automatic, but broke the existing pattern-based prompt exclusion.  [#188](https://github.com/executablebooks/sphinx-copybutton/pull/188) ([@rkdarst](https://github.com/rkdarst)) - MAINT: Add Sphinx Extension classifier (#189)  [#189](https://github.com/executablebooks/sphinx-copybutton/pull/ |
| `v0.5.2` | 2023-04-14 | Low | ## v0.5.2 - 2022-11-15  ([full changelog](https://github.com/executablebooks/sphinx-copybutton/compare/v0.5.1...v0.5.2))   - BUG: Don't exclude `.gp` class by default.  This made excluding prompts more automatic, but broke the existing pattern-based prompt exclusion.  [#188](https://github.com/executablebooks/sphinx-copybutton/pull/188) ([@rkdarst](https://github.com/rkdarst)) - MAINT: Add Sphinx Extension classifier (#189)  [#189](https://github.com/executablebooks/sphinx-copybutton/pull/ |
| `v0.5.2` | 2023-04-14 | Low | ## v0.5.2 - 2022-11-15  ([full changelog](https://github.com/executablebooks/sphinx-copybutton/compare/v0.5.1...v0.5.2))   - BUG: Don't exclude `.gp` class by default.  This made excluding prompts more automatic, but broke the existing pattern-based prompt exclusion.  [#188](https://github.com/executablebooks/sphinx-copybutton/pull/188) ([@rkdarst](https://github.com/rkdarst)) - MAINT: Add Sphinx Extension classifier (#189)  [#189](https://github.com/executablebooks/sphinx-copybutton/pull/ |
| `v0.5.2` | 2023-04-14 | Low | ## v0.5.2 - 2022-11-15  ([full changelog](https://github.com/executablebooks/sphinx-copybutton/compare/v0.5.1...v0.5.2))   - BUG: Don't exclude `.gp` class by default.  This made excluding prompts more automatic, but broke the existing pattern-based prompt exclusion.  [#188](https://github.com/executablebooks/sphinx-copybutton/pull/188) ([@rkdarst](https://github.com/rkdarst)) - MAINT: Add Sphinx Extension classifier (#189)  [#189](https://github.com/executablebooks/sphinx-copybutton/pull/ |
| `v0.5.2` | 2023-04-14 | Low | ## v0.5.2 - 2022-11-15  ([full changelog](https://github.com/executablebooks/sphinx-copybutton/compare/v0.5.1...v0.5.2))   - BUG: Don't exclude `.gp` class by default.  This made excluding prompts more automatic, but broke the existing pattern-based prompt exclusion.  [#188](https://github.com/executablebooks/sphinx-copybutton/pull/188) ([@rkdarst](https://github.com/rkdarst)) - MAINT: Add Sphinx Extension classifier (#189)  [#189](https://github.com/executablebooks/sphinx-copybutton/pull/ |
| `v0.5.2` | 2023-04-14 | Low | ## v0.5.2 - 2022-11-15  ([full changelog](https://github.com/executablebooks/sphinx-copybutton/compare/v0.5.1...v0.5.2))   - BUG: Don't exclude `.gp` class by default.  This made excluding prompts more automatic, but broke the existing pattern-based prompt exclusion.  [#188](https://github.com/executablebooks/sphinx-copybutton/pull/188) ([@rkdarst](https://github.com/rkdarst)) - MAINT: Add Sphinx Extension classifier (#189)  [#189](https://github.com/executablebooks/sphinx-copybutton/pull/ |
| `v0.5.2` | 2023-04-14 | Low | ## v0.5.2 - 2022-11-15  ([full changelog](https://github.com/executablebooks/sphinx-copybutton/compare/v0.5.1...v0.5.2))   - BUG: Don't exclude `.gp` class by default.  This made excluding prompts more automatic, but broke the existing pattern-based prompt exclusion.  [#188](https://github.com/executablebooks/sphinx-copybutton/pull/188) ([@rkdarst](https://github.com/rkdarst)) - MAINT: Add Sphinx Extension classifier (#189)  [#189](https://github.com/executablebooks/sphinx-copybutton/pull/ |
| `v0.5.2` | 2023-04-14 | Low | ## v0.5.2 - 2022-11-15  ([full changelog](https://github.com/executablebooks/sphinx-copybutton/compare/v0.5.1...v0.5.2))   - BUG: Don't exclude `.gp` class by default.  This made excluding prompts more automatic, but broke the existing pattern-based prompt exclusion.  [#188](https://github.com/executablebooks/sphinx-copybutton/pull/188) ([@rkdarst](https://github.com/rkdarst)) - MAINT: Add Sphinx Extension classifier (#189)  [#189](https://github.com/executablebooks/sphinx-copybutton/pull/ |
| `v0.5.2` | 2023-04-14 | Low | ## v0.5.2 - 2022-11-15  ([full changelog](https://github.com/executablebooks/sphinx-copybutton/compare/v0.5.1...v0.5.2))   - BUG: Don't exclude `.gp` class by default.  This made excluding prompts more automatic, but broke the existing pattern-based prompt exclusion.  [#188](https://github.com/executablebooks/sphinx-copybutton/pull/188) ([@rkdarst](https://github.com/rkdarst)) - MAINT: Add Sphinx Extension classifier (#189)  [#189](https://github.com/executablebooks/sphinx-copybutton/pull/ |

## Citation

- HTML: https://www.freshcrate.ai/projects/sphinx-copybutton
- Markdown: https://www.freshcrate.ai/projects/sphinx-copybutton.md
- Dependencies JSON: https://www.freshcrate.ai/api/projects/sphinx-copybutton/deps

_Generated by freshcrate.ai. Indexes pypi releases for AI-agent ecosystem packages._