Skip to content

Commit

Permalink
Merge pull request #507 from jtpio/enable-extension-doc
Browse files Browse the repository at this point in the history
Add documentation for the enable_nbextensions flag
  • Loading branch information
jtpio committed Jan 14, 2020
2 parents e97044f + f709e8b commit 919d57d
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions docs/source/using.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. Copyright (c) 2018, Voila Contributors
Copyright (c) 2018, QuantStack
Distributed under the terms of the BSD 3-Clause License.
The full license is in the file LICENSE, distributed with this software.
.. _using:
Expand Down Expand Up @@ -131,3 +131,25 @@ The examples can then be served with:
cd notebooks/
voila
Using third-party Widgets with Voilà
====================================

By default, Voilà doesn't serve Jupyter Widgets installed as a classic notebook extension (nbextension).

Instead, it fallbacks to fetching the files from a CDN. This might result in an error (404) in case the
custom widget has not been published to ``npm``, or when Voilà runs in an environment without an Internet
connection.

To let the Voilà standalone app serve the nbextensions, use the ``enable_nbextensions`` flag as follows:

.. code-block:: bash
voila --enable_nbextensions=True
When using Voilà as a server extension:

.. code-block:: bash
jupyter notebook --VoilaConfiguration.enable_nbextensions=True

0 comments on commit 919d57d

Please sign in to comment.