Skip to content

Commit c43bf52

Browse files
committed
update doc description, add installation instructions
1 parent 349a01c commit c43bf52

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

doc/source/index.rst

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,25 @@ Jupyter Sphinx Extension
55
:maxdepth: 2
66
:caption: Contents:
77

8-
Jupyter Sphinx is a Sphinx extension that executes embedded code in a Jupyter
9-
kernel, and embeds outputs of that code in the output document. It has support
10-
for rich output such as images, Latex math and even javascript widgets.
8+
Jupyter-sphinx is a Sphinx extension that executes embedded code in a Jupyter
9+
kernel, and embeds outputs of that code in the document. It has support
10+
for rich output such as images, Latex math and even javascript widgets, and
11+
it allows to enable `thebelab <https://thebelab.readthedocs.io/>`_ for live
12+
code execution with minimal effort.
13+
14+
Installation
15+
------------
16+
Get jupyter-sphinx from pip:
17+
18+
.. code-block:: bash
19+
20+
pip install jupyter-sphinx
21+
22+
or conda:
23+
24+
.. code-block:: bash
25+
26+
conda install jupyter-sphinx
1127
1228
Enabling the extension
1329
----------------------

0 commit comments

Comments
 (0)