Add sphinx-copybutton for enhanced documentation interactivity#65
Merged
douglatornell merged 7 commits intomainfrom Feb 25, 2026
Merged
Add sphinx-copybutton for enhanced documentation interactivity#65douglatornell merged 7 commits intomainfrom
sphinx-copybutton for enhanced documentation interactivity#65douglatornell merged 7 commits intomainfrom
Conversation
Added `sphinx-copybutton` as a requirement in the Pixi default environment to enhance code block interaction in the generated documentation. Updated `pixi.lock` and `requirements.txt` accordingly to include the new dependency.
Included the `sphinx_copybutton` extension in the Sphinx configuration file. This enhances the user experience by adding convenient copy buttons to code blocks in the generated documentation.
* Set prompt text regex * Respect bash line continuation character * Add a `no-copybutton` class that can be used to suppress the copy button
douglatornell
added
documentation
Replaced `code-block:: bash` with `code-block:: console` across multiple documentation files for compatibility with `sphinx_copybutton` extension. Added `$` prompt to a few command examples where it was missing.
Replaced `code-block:: bash` with `code-block:: console` across multiple documentation files for compatibility with `sphinx_copybutton` extension. Added `$` prompt to a few command examples where it was missing.
Added the `:class: no-copybutton` directive to relevant `code-block` sections. This ensures that copy buttons do not appear in output-only code examples, improving clarity and user experience.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Integrate the
sphinx-copybuttonextension into the documentation to improve user experience by adding copy buttons to code blocks. Update Sphinx configuration and documentation files to support this feature. Adjust command prompts for consistency across examples.