Skip to content

Commit

Permalink
update description for how to display in jupyter
Browse files Browse the repository at this point in the history
  • Loading branch information
rmorshea committed Sep 3, 2020
1 parent 571ae5e commit e817b78
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,9 @@ connects to it will see a fresh view of the layout. If clients should see views
common state you can use the ``SharedClientStateServer`` instead.

To display the layout we can navigate to http://localhost:8765/client/index.html or
use ``idom.display()`` to show it in a Jupyter Notebook via a widget.
use the dislay function returns by :func:`~idom.widgets.jupyter.init_display` to show it
in a Jupyter Notebook via a widget. See the :ref:`Examples` section for more info on
the ways to display your layouts.

.. Links
.. =====
Expand Down

0 comments on commit e817b78

Please sign in to comment.