Use myst-nb to demo ipywidgets double render bug

[gabalafou]

This PR creates a demo of a bug (#1766). It is not meant to be merged in.

[gabalafou]

You can see the bug at the following preview URL: https://pydata-sphinx-theme--1765.org.readthedocs.build/en/1765/examples/pydata.html#ipywidget

[gabalafou]

Just noticed on that preview URL that ipyleaflet is also rendered twice

[choldgraf]

I wonder if it's because those libraries are calling a display function directly, and then we are doubling that output by calling display ourselves in the cell's code?

[12rambau]

I guess it is but the question is how Jupyter notebook itself prevent this behaviour ?

[gabalafou]

Also, why is there no doubling with nbsphinx?

[12rambau]

Is it also the case if you drop our theme and use the good old alabaster ? If it's the case then the issue is on myst-nb side.

[gabalafou]

I wonder if it's because those libraries are calling a display function directly, and then we are doubling that output by calling display ourselves in the cell's code?

Tested this hypothesis today by replacing the call to display() like so:

-    "display(widgets.VBox([title, tab]))"
+    "widgets.VBox([title, tab])"

The result was the same. The widget rendered twice.

[gabalafou]

Is it also the case if you drop our theme and use the good old alabaster ? If it's the case then the issue is on myst-nb side.

Tested this today. If we use alabaster, we do NOT see the outputs double. So it seems the issue may be with our theme and not myst-nb.

alabaster + myst-nb minimal repro

[gabalafou]

Closing this PR because the description is out of date, plus some of the contents of the PR have already been merged to main (the ipywigets example).