executablebooks / MyST-NB

Parse and execute ipynb files in Sphinx
https://myst-nb.readthedocs.io
BSD 3-Clause "New" or "Revised" License
200 stars 80 forks source link

No displayed output when embedding glued figures from another page/notebook #591

Open markusritschel opened 2 months ago

markusritschel commented 2 months ago

Describe the bug

When I want to embed glue output from other pages, it works with variables but not with figures.

Reproduce the bug

In my jupyter notebook examples/test.ipynb, I have created the following glue object:

# ... create some fig = plt.figure() object ...
from myst_nb import glue
my_variable = "here is some text!"
glue("my_text", my_variable, display=False)
glue("my_figure", fig, display=False)

Now, outside that notebook, in another markdown file, the directive

{glue}`examples/test.ipynb::my_text`

yields the expected output 'here is some text!'.

However, the directive

{glue}`examples/test.ipynb::my_figure`

only returns <Figure size 640x480 with 1 Axes>, without displaying the actual graphic. The following variants don't return anything at all:

{glue:figure}`examples/test.ipynb::my_figure`

```{glue} examples/test.ipynb::my_figure

### List your environment

I'm running the following configuration:
```shell
❯ jupyter-book --version                           
Jupyter Book      : 1.0.0
External ToC      : 1.0.1
MyST-Parser       : 2.0.0
MyST-NB           : 1.0.0
Sphinx Book Theme : 1.1.2
Jupyter-Cache     : 1.0.0
NbClient          : 0.10.0
welcome[bot] commented 2 months ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada: