Skip to content

doc: add copybutton to code snippets #1301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Apr 2, 2025
Merged

doc: add copybutton to code snippets #1301

merged 1 commit into from
Apr 2, 2025

Conversation

ianhi
Copy link
Contributor

@ianhi ianhi commented Apr 1, 2025

Add https://sphinx-copybutton.readthedocs.io/en/latest/ to the doc build. This adds a handy button on code snippets that enables copying the entire block

jeromekelleher
jeromekelleher approved these changes Apr 2, 2025
View reviewed changes
Copy link
Collaborator

@jeromekelleher jeromekelleher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, very handy

tomwhite
tomwhite approved these changes Apr 2, 2025
View reviewed changes
Copy link
Collaborator

@tomwhite tomwhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks @ianhi!

I tried building locally and it adds the copy button.

@tomwhite tomwhite merged commit 4f99a08 into sgkit-dev:main Apr 2, 2025
4 of 10 checks passed
@ianhi ianhi deleted the copybutton branch April 3, 2025 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tomwhite tomwhite tomwhite approved these changes

@jeromekelleher jeromekelleher jeromekelleher approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ianhi @tomwhite @jeromekelleher