File tree 1 file changed +12
-3
lines changed
1 file changed +12
-3
lines changed Original file line number Diff line number Diff line change @@ -225,15 +225,24 @@ in your documentation
225
225
226
226
### Using the ` nbsphinx ` Project
227
227
228
- The [ nbsphinx] ( https://github.com/spatialaudio/nbsphinx ) sphinx extension
228
+ The [ nbsphinx] ( https://nbsphinx.readthedocs.io/ ) Sphinx extension
229
229
provides a source parser for ` *.ipynb ` files. Custom Sphinx directives are used
230
230
to show Jupyter Notebook code cells (and of course their results) in both HTML
231
231
and LaTeX output.
232
-
233
232
In the case of the HTML output, Jupyter Interactive Widgets are also supported.
234
- However, it is a requirement that the notebook was correctly saved with the
233
+
234
+ For notebooks that are executed by ` nbsphinx ` the widget state is automatically
235
+ generated.
236
+ For others, it is a requirement that the notebook was correctly saved with the
235
237
special "Save Notebook Widget State" action in the widgets menu.
236
238
239
+ The necessary JavaScript code is automatically embedded in the generated HTML
240
+ files.
241
+ A custom URL or a local JavaScript file can be specified with the
242
+ ` nbsphinx_widgets_path ` configuration option.
243
+ For more configuration options, have a look at the
244
+ [ documentation] ( https://nbsphinx.readthedocs.io/usage.html ) .
245
+
237
246
## Rendering Interactive Widgets on [ nbviewer] ( http://nbviewer.jupyter.org/ )
238
247
239
248
If your notebook was saved with the special "Save Notebook Widget State" action
You can’t perform that action at this time.
0 commit comments