Feature: add copy
button for code blocks using sphinx-copybutton
#76
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the nice copy button to code blocks via
sphinx-copybutton
https://github.com/executablebooks/sphinx-copybutton
E.g.
I've found these kinds of buttons common in other python docs (e.g. scikit-image)
You can see it at work in a PR to my fork: psobolewskiPhD#5
Here's the built docs artifact: https://github.com/psobolewskiPhD/napari-docs/actions/runs/3725012413
Note that the extension allows for customization such as stripping out prompts, etc. but for now this is just the basics.
https://sphinx-copybutton.readthedocs.io/en/latest/index.html
Type of change
References
https://sphinx-copybutton.readthedocs.io/en/latest/index.html
Final checklist: