Merge pull request #170 from JeanKossaifi/patch-1

DOC: update enabling instructions
jupyter · Oct 29, 2020 · b37e551 · b37e551
2 parents 833e1f4 + 7370b0e
commit b37e551
Showing 1 changed file with 15 additions and 3 deletions.
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -27,8 +27,20 @@ or conda:
 
 Enabling the extension
 ----------------------
-To enable the extension, add ``jupyter_sphinx.execute`` to your enabled extensions in
-``conf.py``.
+
+To enable the extension, add ``jupyter_sphinx`` to your enabled extensions in
+``conf.py``:
+
+.. code-block:: python
+
+   extensions = [
+      'jupyter_sphinx',
+   ]
+      
+
+.. note::
+
+   Since `0.2.4, ``jupyter_sphinx.execute`` is deprecated. Simply use ``jupyter_sphinx`` instead.
 
 Basic Usage
 -----------
@@ -423,4 +435,4 @@ Release 0.3.0
 ~~~~~~~~~~~~~
 
 - Switch the extension name to ``jupyter-sphinx``, deprecate ``jupyter-sphinx.execute``.
-- Miscellaneous bugfixes following the restructuring of the codebase.
+- Miscellaneous bugfixes following the restructuring of the codebase.