Skip to content

Add copy buttons to documentation examples - #762

Open
ac1982 wants to merge 1 commit into
jd:mainfrom
ac1982:docs/copy-example-buttons
Open

ac1982 wants to merge 1 commit into
jd:mainfrom
ac1982:docs/copy-example-buttons

Conversation

@ac1982

@ac1982 ac1982 commented Oct 17, 2026

Copy link
Copy Markdown

Fixes #509 by adding copy buttons to the hosted Sphinx documentation. Copied examples retain Python indentation and omit Python/shell prompts. The existing tested examples remain the source of the rendered code; GitHub's README renderer is unchanged.

Adds sphinx-copybutton to both documentation and development dependencies, plus a Reno note. Strict HTML and doctest builds pass (35 doctests), and Chromium clipboard checks verify the Python example and shell installation command. Ruff checks pass for the configuration. Full runtime/type-check suites were not rerun for this documentation change.

Prepared and validated with OpenAI Codex.

@mergify

mergify Bot commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Suggestion: Improve code snippet readability in documentation for easier copy-paste

1 participant