Skip to content

Commit 127836f

Browse files
authored
docs: mention other execution libs in the index
Fix #64
1 parent 2bf5d6c commit 127836f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/index.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,7 @@ Jupyter Sphinx Extension
1111
options
1212
changelog <https://github.com/jupyter/jupyter-sphinx/releases>
1313

14-
Jupyter-sphinx is a Sphinx extension that executes embedded code in a Jupyter
15-
kernel, and embeds outputs of that code in the document. It has support
16-
for rich output such as images, Latex math and even javascript widgets, and
17-
it allows to enable `thebelab <https://thebelab.readthedocs.io/>`_ for live
18-
code execution with minimal effort.
14+
Jupyter-sphinx is a Sphinx extension that executes embedded code in a Jupyter kernel, and embeds outputs of that code in the document. It has support for rich output such as images, Latex math and even javascript widgets, and it allows to enable `thebelab <https://thebelab.readthedocs.io/>`_ for live code execution with minimal effort.
1915

2016
.. code-block:: rst
2117
@@ -44,3 +40,7 @@ code execution with minimal effort.
4440
:link: thebelab.html
4541

4642
Discover how ``ThebeLab`` is linked to ``jupyter-sphinx``.
43+
44+
.. seealso::
45+
46+
Other extentions exist to display output of IPyhton cells in a Sphinx documentation. If you want to execute entire notebooks you can consider using `nbsphinx <https://nbsphinx.readthedocs.io>`__ or `myst-nb <https://myst-nb.readthedocs.io/>`__. For in-page live execution consider using `sphinx-thebe <https://sphinx-thebe.readthedocs.io/>`__ or `jupyterlite-sphinx <https://jupyterlite-sphinx.readthedocs.io/>`__. For users that don't need to rely on a jupyter kernel the lightweigth `IPython sphinx directive <https://ipython.readthedocs.io/en/stable/sphinxext.html#ipython-sphinx-directive>`__ but remember it will only be able to display text outputs.

0 commit comments

Comments
 (0)