MyST-NB icon indicating copy to clipboard operation
MyST-NB copied to clipboard

Improve the documentation around interactive outputs

Open choldgraf opened this issue 5 years ago • 1 comments

It is tricky to get interactive outputs to work properly with Jupyter Notebooks and conversion into HTML. This definitely isn't unique to MyST-NB, or to sphinx, but we should document best-practices for how to do so.

In the interactive docs, I have some minimal code showing how things show up in the rendered page:

https://myst-nb.readthedocs.io/en/latest/use/interactive.html

However, we don't do a ton of troubleshooting, best-practices, etc. Some libraries are more consistent than others. But, for example, ipywidgets seem to disappear at rendering in unpredictable ways. We should document some of these challenges

choldgraf avatar Mar 25 '20 00:03 choldgraf

The issue is that it renders widgets even if widget state isn’t recorded.

Widget View execution_results/display_data should be ignored in favor of other mime types if there’s no recorded widget state.

So this is a bug and not only a documentation error (we should tell people to use Jupyter Lab and “Automatically save Widget State” and not VS Code if they want to see their widgets)

flying-sheep avatar Sep 22 '25 08:09 flying-sheep