Skip to content

Commit

Permalink
docs: Mention JupyterLab and use heading
Browse files Browse the repository at this point in the history
Mention JupyterLab in the FAQ. This is a useful addition
in case people are searching for it.

This commit also uses a second-level heading for questions in the FAQ
section. This will allow linking to specific questions.
  • Loading branch information
riddell-stan committed Feb 27, 2021
1 parent 961784a commit b78eac8
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions doc/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@
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.
How can I use PyStan with Jupyter Notebook or JupyterLab?
---------------------------------------------------------

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 and derivatives. It does not affect IPython.

0 comments on commit b78eac8

Please sign in to comment.