8000 Reintroduce copybutton to all code examples by ccwang002 · Pull Request #26 · python/python-docs-theme · GitHub
[go: up one dir, main page]
Skip to content

Reintroduce copybutton to all code examples#26

Merged
theacodes merged 1 commit intopython:masterfrom
ccwang002:fix-copybutton
Feb 16, 2019
Merged

Reintroduce copybutton to all code examples#26
theacodes merged 1 commit intopython:masterfrom
ccwang002:fix-copybutton

Conversation

@ccwang002
Copy link
Contributor
@ccwang002 ccwang002 commented Feb 16, 2019

Many code examples on the official Python documentation do not have a >>> copy button. For example, the code snippets in the current collections module. Those examples were excluded since Sphinx assigns a different highlight language to those code-blocks.

In the past, Sphinx used python3 to highlight all the doctest and malformed code blocks (started with : instead of ::). Those blockes had the highlight-python3 CSS class in the generated HTML. For example, see the collections 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 become default for unknown reason. Therefore, those blocks are not captured by copybutton.js due to a different CSS class name. There are in total 185 doctests and 382 malformed(?) code blocks highlighted by pycon and default language in the latest Python official documentation. Note that the default language has a similar behavior to python3.

This pull request lets code blocks of two additional languages (pycon and default) to add the copybutton.

All occurrences of hightlight-pycon in current Python master: 
install/index.html:1
faq/windows.html:2
faq/extending.html:2
faq/programming.html:2
whatsnew/3.2.html:1
whatsnew/2.7.html:11
extending/embedding.html:1
extending/extending.html:1
extending/newtypes_tutorial.html:5
library/shlex.html:1
library/re.html:4
library/urllib.parse.html:2
library/multiprocessing.html:7
howto/sorting.html:1
howto/logging-cookbook.html:2
library/turtle.html:72
library/decimal.html:12
library/unittest.mock.html:4
library/http.cookies.html:1
library/statistics.html:19
library/secrets.html:3
library/ssl.html:1
library/email.compat32-message.html:2
library/email.policy.html:1
library/traceback.html:1
library/collections.html:7
library/email.message.html:2
library/datetime.html:2
library/difflib.html:1
library/email.iterators.html:1
library/configparser.html:13
All occurrences of hightlight-default in current Python master: 
tutorial/floatingpoint.html:1
faq/programming.html:8
whatsnew/3.2.html:32
whatsnew/2.7.html:2
library/getopt.html:2
library/shlex.html:3
library/hashlib.html:10
library/re.html:3
library/unicodedata.html:1
library/urllib.parse.html:3
library/functions.html:10
library/weakref.html:6
library/base64.html:1
library/ftplib.html:1
library/reprlib.html:1
library/turtle.html:3
library/inspect.html:1
library/pprint.html:4
library/operator.html:5
library/unittest.mock-examples.html:55
library/decimal.html:23
library/unittest.mock.html:72
library/copyreg.html:1
library/ssl.html:3
library/time.html:1
library/fractions.html:3
library/functools.html:1
library/ipaddress.html:19
library/pathlib.html:2
library/fnmatch.html:1
library/collections.html:18
library/stdtypes.html:12
library/datetime.html:10
library/difflib.html:17
library/nntplib.html:6
howto/ipaddress.html:3
howto/functional.html:15
howto/sorting.html:22
reference/lexical_analysis.html:1

@theacodes
Copy link
Collaborator
theacodes commented Feb 16, 2019

Thank you, @ccwang002!

@theacodes theacodes merged commit 6487f56 into python:master Feb 16, 2019
@ccwang002
Copy link
Contributor Author
ccwang002 commented Feb 18, 2019

Sorry about this, but I just realized that in the next Sphinx release, we might need to include pycon3 language as well (ref: sphinx-doc/sphinx#5770).

@JulienPalard
Copy link
Member
JulienPalard commented Feb 18, 2019 •
edited
Loading

On the contrary, you're finding an issue before it happen, I think this is great ^^

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@theacodes theacodes theacodes 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

@ccwang002 @theacodes @JulienPalard
0