Skip to content

Commit

Permalink
docs: Add FAQ item on Jupyter Notebook
Browse files Browse the repository at this point in the history
Add FAQ answer about Jupyter Notebook.

Closes #217
  • Loading branch information
riddell-stan committed Feb 25, 2021
1 parent 5486c1c commit 2aa4c26
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
12 changes: 12 additions & 0 deletions doc/faq.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
============================
Frequently Asked Questions
============================

How can I use PyStan with Jupyter Notebook?
Use `nest-asyncio <https://pypi.org/project/nest-asyncio/>`_. This package is needed
because Jupter Notebook blocks the use of certain `asyncio
<https://docs.python.org/3/library/asyncio.html>`_ functions. (To verify this, try
running ``asyncio.run(asyncio.sleep(1))`` in a notebook.) If you would like to learn
more about the problem, see the following issue: `ipython/ipykernel#548
<https://github.com/ipython/ipykernel/issues/548>`_. This problem only affects Jupyter
Notebook. It does not affect IPython.
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,4 @@ Documentation
reference
plugins
contributing
faq

0 comments on commit 2aa4c26

Please sign in to comment.