NotificationsYou must be signed in to change notification settings
Fork32.2k
Star67.7k

gh-107024 Added copy button to code snippets in documentation#107037

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

Jump to bottom

Open

churnikov wants to merge6 commits intopython:main

base:main

Choose a base branch

fromchurnikov:gh-107024-copy-button

Open

gh-107024 Added copy button to code snippets in documentation#107037

churnikov wants to merge6 commits intopython:mainfromchurnikov:gh-107024-copy-button

Conversation

Copy link

churnikov commentedJul 22, 2023•
edited by github-actionsbot
Loading

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.

Issue:Proposal to add copy button to code examples #107024

📚 Documentation preview 📚:https://cpython-previews--107037.org.readthedocs.build/

Added copy button as a demo, needs more work. Overwrites >>> toggle b…

29a4d93

…utton

Copy link

bedevere-bot commentedJul 22, 2023

Most changes to Pythonrequire a NEWS entry.

Please add it using theblurb_it web app or theblurb command-line tool.

bedevere-bot mentioned this pull request

Jul 22, 2023

Proposal to add copy button to code examples#107024

Open

Copy link

ghost commentedJul 22, 2023•
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.

excluded from copy code output and repl signs

46e9b67

Copy link

bedevere-bot commentedJul 22, 2023

Most changes to Pythonrequire a NEWS entry.

Please add it using theblurb_it web app or theblurb command-line tool.

added news

8ddef13

Copy link

bedevere-bot commentedJul 22, 2023

Most changes to Pythonrequire a NEWS entry.

Please add it using theblurb_it web app or theblurb command-line tool.

fix dependencies

0e3e817

Copy link

bedevere-bot commentedJul 22, 2023

Most changes to Pythonrequire a NEWS entry.

Please add it using theblurb_it web app or theblurb command-line tool.

churnikov added2 commits

July 23, 2023 13:16

added sphinx-copybutton to oldest requirements for sphinx docs; added…

048320e

… news with blurb

Merge branch 'main' intopythongh-107024-copy-button

2b5b226

churnikov marked this pull request as ready for review

July 23, 2023 11:21

bedevere-bot added the awaiting review label

Jul 23, 2023

ezio-melotti requested review fromhugovk,AA-Turner andezio-melotti

July 27, 2023 18:59

Copy link

Member

AA-Turner commentedJul 27, 2023•
edited
Loading

We could add this topython-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.

hugovk reviewed

Jul 27, 2023

View reviewed changes

Doc/conf.py

		@@ -22,6 +22,7 @@
		'pyspecific',
		'sphinx.ext.coverage',
		'sphinx.ext.doctest',
		'sphinx_copybutton',

Copy link

Member

hugovkJul 27, 2023

Choose a reason for hiding this comment

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

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.