Skip to content

Commit 01edede

Browse files
authored
Minor documentation copyedit (#286)
2 parents 5f5e24a + 9b8c33e commit 01edede

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +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 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.
14+
Jupyter-sphinx is a Sphinx extension that executes embedded code in a Jupyter kernel and embeds the 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 enabling `thebe <https://thebe.readthedocs.io/>`_ for live code execution with minimal effort.
1515

1616
.. code-block:: rst
1717
@@ -43,4 +43,4 @@ Jupyter-sphinx is a Sphinx extension that executes embedded code in a Jupyter ke
4343

4444
.. seealso::
4545

46-
Other extensions 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>`__ can be used but remember it will only be able to display text outputs.
46+
Other extensions exist to display the output of IPython cells in 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 lightweight `IPython sphinx directive <https://ipython.readthedocs.io/en/stable/sphinxext.html#ipython-sphinx-directive>`__ can be used but remember it will only be able to display text outputs.

0 commit comments

Comments
 (0)