Voici directive

jupyterlite-sphinx provides a voici directive that allows you to embed a voici dashboard in your docs.

.. voici::
   :height: 600px

You can provide a notebook file (either Jupyter-based or MyST-Markdown flavoured) that will be rendered with Voici:

1. Jupyter Notebook

.. voici:: my_notebook.ipynb
   :height: 600px
   :prompt: Try Voici!
   :prompt_color: #dc3545

Try Voici!

2. MyST Markdown

.. voici:: my_markdown_notebook.md
   :height: 600px
   :prompt: Try Voici!
   :prompt_color: `#dc3545`

Try Voici!

If you use the :new_tab: option in the directive, the Voici dashboard will execute and render the notebook in a new browser tab, instead of in the current page.

.. voici:: my_notebook.ipynb
   :new_tab: True

Open with Voici

When using this option, it is also possible to customise the button text, overriding the global value using an additional :new_tab_button_text: parameter:

.. voici:: my_notebook.ipynb
   :new_tab: True
   :new_tab_button_text: My custom Voici button text

My custom Voici button text