How to include .ipynb files?

[kevinsawade]

The documentation says:

Once activated, the MyST-NB Sphinx extension will automatically parse both markdown (.md) and Jupyter notebooks (.ipynb) into your Sphinx site.

But how does one actually do this?

My project structure:

├── docs/
│   └── source/
│       ├── conf.py
│       ├── index.rst
│       └── example1.ipynb
├── setup.py
├── package/
│   ├── __init__.py
│   └── module.py
└── examples/
    └── example1.ipynb

What I tried:

1. Using the .. include:: directive does not work:

.. include:: ../../examples/example1.ipynb

2. Putting the .ipynb file into the toctree:

.. toctree::
   :maxdepth: 1

   example1.ipynb

The sites are there, but a NotImplementedError is raised:

The HTML pages are in build\html.
Error in atexit._run_exitfuncs:
Traceback (most recent call last):
  File "C:\Users\Kevin\anaconda3\envs\py38_tf2\lib\site-packages\nbclient\client.py", line 378, in _async_cleanup_kernel
    await ensure_async(self.kc.stop_channels())
  File "C:\Users\Kevin\anaconda3\envs\py38_tf2\lib\site-packages\jupyter_client\client.py", line 124, in stop_channels
    if self.shell_channel.is_alive():
  File "C:\Users\Kevin\anaconda3\envs\py38_tf2\lib\site-packages\jupyter_client\client.py", line 150, in shell_channel
    socket = self.connect_shell(identity=self.session.bsession)
  File "C:\Users\Kevin\anaconda3\envs\py38_tf2\lib\site-packages\jupyter_client\connect.py", line 564, in connect_shell
    return self._create_connected_socket('shell', identity=identity)
  File "C:\Users\Kevin\anaconda3\envs\py38_tf2\lib\site-packages\jupyter_client\connect.py", line 548, in _create_connected_socket
    sock = self.context.socket(socket_type)
  File "C:\Users\Kevin\anaconda3\envs\py38_tf2\lib\site-packages\zmq\sugar\context.py", line 235, in socket
    s = self._socket_class(self, socket_type, **kwargs)
  File "C:\Users\Kevin\anaconda3\envs\py38_tf2\lib\site-packages\zmq\_future.py", line 150, in __init__
    self._init_io_state()
  File "C:\Users\Kevin\anaconda3\envs\py38_tf2\lib\site-packages\zmq\asyncio.py", line 51, in _init_io_state
    self.io_loop.add_reader(self._fd, lambda: self._handle_events(0, 0))
  File "C:\Users\Kevin\anaconda3\envs\py38_tf2\lib\asyncio\events.py", line 501, in add_reader
    raise NotImplementedError
NotImplementedError
Exception ignored in: <function Socket.__del__ at 0x0000017B599303A0>
Traceback (most recent call last):
  File "C:\Users\Kevin\anaconda3\envs\py38_tf2\lib\site-packages\zmq\sugar\socket.py", line 66, in __del__
    self.close()
  File "C:\Users\Kevin\anaconda3\envs\py38_tf2\lib\site-packages\zmq\_future.py", line 168, in close
    self._clear_io_state()
  File "C:\Users\Kevin\anaconda3\envs\py38_tf2\lib\site-packages\zmq\asyncio.py", line 58, in _clear_io_state
    self.io_loop.remove_reader(self._fd)
  File "C:\Users\Kevin\anaconda3\envs\py38_tf2\lib\asyncio\events.py", line 504, in remove_reader
    raise NotImplementedError
NotImplementedError:

Any help on this would be appreciated.