Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork66
Reintroduce copybutton to all code examples#26
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This file contains hidden or 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
theacodes approved these changesFeb 16, 2019
Thank you,@ccwang002! |
Sorry about this, but I just realized that in the next Sphinx release, we might need to include |
Member
JulienPalard commentedFeb 18, 2019 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
On the contrary, you're finding an issuebefore it happen, I think this is great ^^ |
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
None yet
3 participants
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.
Many code examples on the official Python documentation do not have a
>>>copy button. For example, the code snippets in the currentcollections module. Those examples were excluded since Sphinx assigns a different highlight language to those code-blocks.In the past, Sphinx used
python3to highlight all the doctest and malformed code blocks (started with:instead of::). Those blockes had thehighlight-python3CSS class in the generated HTML. For example, see thecollections module in Python 3.3.However, with the recent change in Sphinx (sphinx-doc/sphinx#4137), the doctest blocks are highlighted by
pycon, and malformed blocks becomedefaultfor unknown reason. Therefore, those blocks are not captured bycopybutton.jsdue to a different CSS class name. There are in total 185 doctests and 382 malformed(?) code blocks highlighted bypyconanddefaultlanguage in the latest Python official documentation. Note that thedefaultlanguage has a similar behavior topython3.This pull request lets code blocks of two additional languages (
pyconanddefault) to add the copybutton.All occurrences of hightlight-pycon in current Python master:
All occurrences of hightlight-default in current Python master: