Don't configure the "sphinx-copybutton" extension #1653
Merged
Conversation
This file contains 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
This PR simply removes the sphinx-copybutton extension-specific configuration from the sphinx configuration file. this is because the configuration was in some cases returning bad data. the prompt text configuration seems complicated and difficult to get right to support the wide range of code samples we have in the documentation. for now, having a copy button that copies the entire code sample is better than a smart copy button that only copies the "right" piece of code modified: docs/source/conf.py
|
LGTM. Thank you! |
mdickinson
approved these changes
Jun 29, 2022
mdickinson
pushed a commit
that referenced
this pull request
Aug 9, 2022
FIX: Dont configure the sphinx copybutton extension in docs This PR simply removes the sphinx-copybutton extension-specific configuration from the sphinx configuration file. this is because the configuration was in some cases returning bad data. the prompt text configuration seems complicated and difficult to get right to support the wide range of code samples we have in the documentation. for now, having a copy button that copies the entire code sample is better than a smart copy button that only copies the "right" piece of code modified: docs/source/conf.py (cherry picked from commit 0b64767)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR simply removes the
sphinx-copybuttonextension-specific configuration from the sphinx configuration file.This is because the configuration was in some cases returning bad data. See for example the
all_wildcard.pycode block at https://traits.readthedocs.io/en/latest/traits_user_manual/advanced.html#trait-attribute-name-wildcard. Trying to copy that codeblock returns only the code within"""and not the actual class. The prompt text configuration seems complicated and difficult to get "right" to support the wide range of code samples we have in the documentation.For now, having a copy button that copies the entire code sample is better than a smart copy button that only copies the "right" piece of code
Checklist
TestsUpdate API reference (docs/source/traits_api_reference)Update User manual (docs/source/traits_user_manual)Update type annotation hints intraits-stubs