Skip to content

Commit b37e551

Browse files
authored
Merge pull request #170 from JeanKossaifi/patch-1
DOC: update enabling instructions
2 parents 833e1f4 + 7370b0e commit b37e551

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

doc/source/index.rst

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,20 @@ or conda:
2727
2828
Enabling the extension
2929
----------------------
30-
To enable the extension, add ``jupyter_sphinx.execute`` to your enabled extensions in
31-
``conf.py``.
30+
31+
To enable the extension, add ``jupyter_sphinx`` to your enabled extensions in
32+
``conf.py``:
33+
34+
.. code-block:: python
35+
36+
extensions = [
37+
'jupyter_sphinx',
38+
]
39+
40+
41+
.. note::
42+
43+
Since `0.2.4, ``jupyter_sphinx.execute`` is deprecated. Simply use ``jupyter_sphinx`` instead.
3244

3345
Basic Usage
3446
-----------
@@ -423,4 +435,4 @@ Release 0.3.0
423435
~~~~~~~~~~~~~
424436

425437
- Switch the extension name to ``jupyter-sphinx``, deprecate ``jupyter-sphinx.execute``.
426-
- Miscellaneous bugfixes following the restructuring of the codebase.
438+
- Miscellaneous bugfixes following the restructuring of the codebase.

0 commit comments

Comments
 (0)