Improve TryExamples customization #129
Merged
Conversation
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
- and update how try examples config is specified
steppi
added
documentation
Carreau
approved these changes
Jan 31, 2024
| .try_examples_button_container { | ||
| display: flex; | ||
| justify-content: flex-end; | ||
| } |
There was a problem hiding this comment.
👍 Thanks for your patience on the review, I'm just back from PTO.
| @@ -28,4 +28,7 @@ | |||
| ] | |||
| } | |||
|
|
|||
| html_static_path = ["_static"] | |||
| html_css_files = ["try_examples.css"] | |||
|
|
|||
| display: flex; | ||
| justify-content: flex-end; | ||
| } | ||
| ``` |
| @@ -184,23 +224,38 @@ directory of the build directory for the deployed documentation. The format is a | |||
| `TryExamples` buttons will be hidden in url pathnames matching at least one of these | |||
| patterns, effectively disabling the interactive documentation. In the provided example: | |||
|
|
|||
| * The pattern `".*latest/.*" disables interactive examples for urls for the documentation | |||
| * The pattern `"^/latest/.*"` disables interactive examples for urls for the documentation | |||
| "button_horizontal_position": directives.unchanged, | ||
| "button_vertical_position": directives.unchanged, | ||
| "min_height": directives.unchanged, | ||
| "example_class": directives.unchanged, |
| f" 'top' or 'bottom', received {button_vertical_position}." | ||
| ) | ||
| height = self.options.pop("height", None) | ||
| example_class = self.options.pop("example_class", "") |
There was a problem hiding this comment.
Not a fix for this PR, but do we want to check here that example_class is a valid class name ? (no space, no dots, no /\ or angle brackets for example) as we do inject it with fstrings it might break the html/css otherwise
| "try_examples_default_runtime_config", | ||
| default=None, | ||
| rebuild=None, | ||
| ) |
There was a problem hiding this comment.
I love when a bunch of lines get deleted.
|
Ok, let's get that in. I'll open an issue to think about validating the height and example_class |
|
Thanks @Carreau! |
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.
Closes #122, #127
This PR updates
TryExamplesDirectiveto use the standard method of allowing custom css in Sphinx to customize the buttons as suggested by Carreau here. It also adds customization ofmin_heightto the config filetry_examples.jsonso that the minimum height can bet changed at runtime. An option has been given to the directive to set the specific height of the iframe container for the embedded notebook and themin_heightoption has been removed. The specific height overrides the minimum height set intry_examples.json. I've also attempted to improve the documentation, and have added anexample_classoption to the directive which can be targeted in custom css as suggested by Carreau.