Skip to content

Commit 9db86d1

Browse files
committed
mention that Jupyter Sphinx works with autodoc
Closes #47.
1 parent 19d2e40 commit 9db86d1

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

doc/source/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ to ``jupyter-execute``::
7979

8080
.. jupyter-execute:: some_code.py
8181

82+
``jupyter-execute`` may also be used in docstrings within your Python code, and will be executed
83+
when they are included with Sphinx autodoc.
84+
8285

8386
Directive options
8487
-----------------

0 commit comments

Comments
 (0)