Skip to content

Commit 40d4a72

Browse files
Update options docs for TryExamples directive
1 parent 0015c81 commit 40d4a72

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/directives/try_examples.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,13 +118,14 @@ positioning of the button. The css for the example above is
118118

119119
The `try_examples` directive has these options:
120120

121-
* `:height:` To set a specific value for the height of the [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) containing the embeddednotebook.
121+
* `:height:` To set a specific value for the height of the [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) containing the embedded notebook.
122122
* `:button_text` To customize the text of the button that replaces the rendered examples with an embedded notebook. The default value is `"Try it with JupyterLite!"`, or the value of the global configuration variable `try_examples_global_button_text` if it is set in `conf.py`.
123123
* `:theme:` This works the same as for the other JupyterLite-Sphinx directives.
124124
* `:example_class:` An html class to attach to the outer container for the rendered
125125
examples content and embedded notebook. This can be used in a custom css file to allow
126126
for more precise customization, eg. different button styles across different examples.
127-
* `:warning_text:` Prepend a markdown cell to the notebook containing this text, styled to make it clear this is intended as a warning.
127+
The default value is the value of the global configuration variable `try_examples_global_theme`, if it is set in `conf.py`.
128+
* `:warning_text:` Prepend a markdown cell to the notebook containing this text, styled to make it clear this is intended as a warning. The default value is the value of the global configuration variable `try_examples_global_warning_text` if it is set in `conf.py`, otherwise no warning text is added.
128129

129130
Here's an example with some options set
130131

0 commit comments

Comments
 (0)