docs(dev): add copy button for code blocks #15746
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
di
reviewed
Apr 10, 2024
Comment on lines
+30
to
+32
| git checkout -b update_dev_db_dump | ||
| git add dev/example.sql.xz | ||
| git commit -m "Update development database dump" |
There was a problem hiding this comment.
These multi-line command blocks don't really copy correctly, we might want to break them into separate blocks instead.
There was a problem hiding this comment.
Can you explain what you mean? I tested the copy button, and my clipboard contents have:
git checkout -b update_dev_db_dump
git add dev/example.sql.xz
git commit -m "Update development database dump"
There was a problem hiding this comment.
Since copy/pasting this into a terminal would result in the first two lines immediately being executed due to the newlines, I would expect this to either be:
git checkout -b update_dev_db_dump
git add dev/example.sql.xz
git commit -m "Update development database dump"
or:
git checkout -b update_dev_db_dump; \
git add dev/example.sql.xz; \
git commit -m "Update development database dump"
To make it easier to copy code from the docs and paste into a terminal, add `sphinx-copybutton` which Furo theme already supports. Refs: https://pypi.org/project/sphinx-copybutton/ Remove leading `$` signs for commands, since they should not be copied. Signed-off-by: Mike Fiedler <miketheman@gmail.com>
miketheman
force-pushed
the
miketheman/dev-docs
branch
from
5873382
to
35be698
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
To make it easier to copy code from the docs and paste into a terminal, add
sphinx-copybuttonwhich Furo theme already supports. Refs: https://pypi.org/project/sphinx-copybutton/Remove leading
$signs for commands, since they should not be copied.