Repository navigation
gh-107024 Added copy button to code snippets in documentation - #107037
churnikov wants to merge 6 commits into
Conversation
Sorry, something went wrong.
|
Most changes to Python require a NEWS entry. Please add it using the blurb_it web app or the blurb command-line tool. |
Sorry, something went wrong.
|
All commit authors signed the Contributor License Agreement. |
Sorry, something went wrong.
|
Most changes to Python require a NEWS entry. Please add it using the blurb_it web app or the blurb command-line tool. |
Sorry, something went wrong.
|
Most changes to Python require a NEWS entry. Please add it using the blurb_it web app or the blurb command-line tool. |
Sorry, something went wrong.
|
Most changes to Python require a NEWS entry. Please add it using the blurb_it web app or the blurb command-line tool. |
Sorry, something went wrong.
|
We could add this to python-docs-theme instead, to have all users of that theme benefit from this change? That would also enable making the necessary styling changes in one place. A |
Sorry, something went wrong.
| 'pyspecific', | ||
| 'sphinx.ext.coverage', | ||
| 'sphinx.ext.doctest', | ||
| 'sphinx_copybutton', |
There was a problem hiding this comment.
We've been cautious about including third-party extensions, in case downstream redistributors haven't installed them. See the try/except block just below for sphinxext.opengraph.
All the others here are Sphinx builtin extensions, or our own custom ones.
Sorry, something went wrong.
| sphinxcontrib-qthelp==1.0.3 | ||
| sphinxcontrib-serializinghtml==1.1.5 | ||
| urllib3==1.26.15 | ||
| sphinx-copybutton<0.6 |
There was a problem hiding this comment.
This file is meant to be a generated list of pinned dependencies, see instructions at the top.
Sorry, something went wrong.
| blurb | ||
|
|
||
| sphinxext-opengraph==0.7.5 | ||
| sphinx-copybutton<0.6 |
There was a problem hiding this comment.
Why the upper version limit?
Sorry, something went wrong.
|
Sure, I could do that if think that would be better |
Sorry, something went wrong.
|
This has been implemented in python/python-docs-theme@d528dbc |
Sorry, something went wrong.
I added sphinx-copybutton to documentation dependencies, which results in the following button in code snippets
If this is a right thing to do, then this requires a bit more work, as this right now copies the whole code block, but it could be changed through configuration.
It also overrides >>> toggle button where applicable. This has to be fixed or decided to be dropped and made so that copy button copies code without >>> and output.
📚 Documentation preview 📚: https://cpython-previews--107037.org.readthedocs.build/