Add option for initial warning cell in try examples directive - #143
Merged
Conversation
Carreau
approved these changes
Mar 1, 2024
Co-authored-by: M Bussonnier <bussonniermatthias@gmail.com>
Collaborator
Author
|
Thanks @Carreau. Yes, that should definitely be keyword only. |
Collaborator
Author
|
I've rebuilt the SciPy docs at https::/steppi.github.io/scipy against this branch. See https://steppi.github.io/scipy/reference/generated/scipy.integrate.quad.html#scipy.integrate.quad for a specific example. |
Collaborator
|
Let's get that in. Thanks ! |
Collaborator
Author
|
Thanks @Carreau! |
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
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 #142
This PR updates the code for auto generating the notebooks to have the option to add an initial "warning" cell like discussed in #142. This has been added as a configuration option both at the individual directive level, and at the global level with option
try_examples_global_warning_text, similar to the existingtry_examples_global_button_textetc.I just looked the json for one of Scikit-Learn's notebooks and copied that formatting there. Basically, wrapping the text supplied in the config with a
<div class='alert alert-warning'>. Jupyter is apparently has some css that's aware of this formatting and styles things appropriately.