Jupyter-book: code-cell inside a "special block" in a markdown cell of Jupyter Notebook

[spring-haru]

I tried to execute a code inside a "special block" in a markdown cell in Jupyter Notebook:

`` {tip}
Here is a sentence.
```{code-cell} python3
z = 100

Here is another sentence.
````
``````

It generates an error:

WARNING: Unknown directive type "code-cell".
```
Is it an expected result?

[choldgraf]

Yep - unfortunately you can't put code cells inside of things like tips :-/

I think we should have code-cell return a more informative error though

[najuzilu]

There's a workaround if you'd like to include a code-cell in a directive which does not support it. I have discussed it in issue #671. Check it out and let us know if it is helpful.

@choldgraf I think that would be useful. We can also include an example of the workaround in the documentation if you think that will help the users.

[choldgraf]

@najuzilu though doesn't that only work for the toggle directive?

[najuzilu]

@choldgraf it actually works for the admonition directives as well. Here's the example I tested:

`` {tip}
Here is a sentence.

print("Hello World!")

{glue:}glued_txt
````

% The code cell below is not displayed
```{code-cell} ipython3
:tags: [remove-cell]

from myst_nb import glue
my_variable = "Hello World!"
glue("glued_txt", my_variable)
```
``````
This is what it looks like:

[choldgraf]

ahhh right! I missed that part of your explanation, good point 👍

maybe we can add an extra section here: https://jupyterbook.org/content/content-blocks.html#notes-warnings-and-other-admonitions like "how to insert code outputs into your admonition blocks" and show a short example, then cross-link to the glue docs?

[spring-haru]

@najuzilu
I inserted your code in a markdown cell of a Jupyter Notebook, and

jb clean . --all
jb build .

but the following error messages were generated:

WARNING: Unknown directive type "code-cell".

WARNING: Couldn't find key `glued_txt` in keys defined across all pages.

What am I missing here?

myst-nb: 0.8.1
jupyter-book: 0.7.0b4
Python: 3.8.2

[najuzilu]

@choldgraf would glue work on a Jupyter Notebook? I work primarily with .md files.

[choldgraf]

well, if you're working in a notebook, then you shouldn't use {code-cell}, you should just write code in the notebook like you normally would (and put glue() in that code).

[spring-haru]

The following worked!

Place the following in a markdown cell:
`` {tip}
Here is a sentence.

print("Hello World!")

{glue:}glued_txt
````
``````

Place the following in a code cell with a tag remove-cell:

from myst_nb import glue
my_variable = "Hello World!"
glue("glued_txt", my_variable)

[choldgraf]

yes, that's it! Perhaps we can add the note about remove_cell to the docs here: https://jupyterbook.org/content/content-blocks.html#insert-code-cell-outputs-into-admonitions ?