Here’s an example
And here’s a code block, note the copy button to the right!
If the code block overlaps to the right of the text area, you can just click the button to get the whole thing.
You can configure
sphinx-copybutton to detect input prompts in code
cells, and then both remove these prompts before copying, as well as skip
lines that don’t start with prompts (in case they are output lines).
For example, this site has been configured to strip Python prompts (“>>> “) and output lines. Try copy-pasting the code block below.
>>> a = 2 >>> print(a) 2 >>> >>> b = 'wow' >>> print(b) wow
You can install
pip install sphinx-copybutton
conda install -c conda-forge sphinx-copybutton
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!
See Use and customize for more information about how to use
- Use and customize
- Reference examples
The UI and design elements of
sphinx-copybutton are heavily inspired by GitHub’s design choices.
The icon we use is from Tabler’s icons set.