Skip to content

Commit ab54ea0

Browse files
authored
Merge pull request jupyter-widgets#2577 from mgeier/doc-nbsphinx
DOC: Update instructions for nbsphinx
2 parents d685e1e + c2f9178 commit ab54ea0

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

docs/source/embedding.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -225,15 +225,24 @@ in your documentation
225225

226226
### Using the `nbsphinx` Project
227227

228-
The [nbsphinx](https://github.com/spatialaudio/nbsphinx) sphinx extension
228+
The [nbsphinx](https://nbsphinx.readthedocs.io/) Sphinx extension
229229
provides a source parser for `*.ipynb` files. Custom Sphinx directives are used
230230
to show Jupyter Notebook code cells (and of course their results) in both HTML
231231
and LaTeX output.
232-
233232
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
235237
special "Save Notebook Widget State" action in the widgets menu.
236238

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+
237246
## Rendering Interactive Widgets on [nbviewer](http://nbviewer.jupyter.org/)
238247

239248
If your notebook was saved with the special "Save Notebook Widget State" action

0 commit comments

Comments
 (0)