diff --git a/doc/faq.rst b/doc/faq.rst index db9ed2205..703df649e 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -36,22 +36,22 @@ Take a look at this video. For more details, consult the :ref:`tutorial = 1.0, Glue can be started from the IPython HTML notebook -without blocking, so that both the notebook and the Glue UI can run at once. -This requires starting the notebook such that it cooperates with Qt. To do this, -start the notebook with:: +For IPython version >= 4.0, Glue can be started from a Jupyter notebook without +blocking, so that both the notebook and the Glue UI can run at once. This +requires running the following magic function:: - ipython notebook --gui qt + %gui qt -And then starting glue (probably by calling :ref:`qglue `) from the +And then starting glue (probably by calling :ref:`qglue ` or creating an +instance of :class:`~glue.app.qt.application.GlueApplication`) from the notebook. If you encounter an error like this:: ValueError: API 'QString' has already been set to version 1 -set the ``QT_API`` environment variable to either ``pyqt`` or ``pyside``, -depending on which version of Qt you have installed:: +set the ``QT_API`` environment variable to either ``pyqt``, ``pyqt5``, or +``pyside``, depending on which version of Qt you have installed:: QT_API=pyside ipython notebook --gui qt