diff --git a/docs/howto/admin/enable-extensions.rst b/docs/howto/admin/enable-extensions.rst new file mode 100644 index 0000000..3dd5b18 --- /dev/null +++ b/docs/howto/admin/enable-extensions.rst @@ -0,0 +1,60 @@ +.. _howto/admin/extensions: + +==================================== +Enabling Jupyter Notebook extensions +==================================== + +Jupyter contributed notebook +`extensions `_ are +community-contributed and maintained plug-ins to the Jupyter notebook. These extensions +serve many purposes, from `pedagogical tools `_ +to tools for `converting `_ +and `editing `_ +notebooks. + +Extensions are often added and enabled through the graphical user interface of the notebook. +However, this interface only makes the extension available to the user, not all users on a +hub. Instead, to make contributed extensions available to your users, you will use the command +line. This can be completed using the terminal in the JupyterHub (or via SSH-ing into your +VM and using this terminal). + +.. _tljh_extension_cli: + +Enabling extensions via the command line +======================================== + +#. There are `multiple ways `_ + to install contributed extensions. For this example, we will use ``pip``. + + .. code-block:: bash + + sudo -E pip install jupyter_contrib_nbextensions + +#. Next, add the notebook extension style files to the Jupyter configuration files. + + .. code-block:: bash + + sudo -E jupyter contrib nbextension install --system + +#. Then, you will enable the extensions you would like to use. The syntax for this is + ``jupyter nbextension enable`` followed by the path to the desired extension's main file. + For example, to enable `scratchpad `_, + you would type the following: + + .. code-block:: bash + + sudo -E jupyter nbextension enable scratchpad/main --system + +#. When this is completed, the enabled extension should be visible in the extension list: + + .. code-block:: bash + + jupyter nbextension list + +#. You can also verify the availability of the extension via its user interface in the notebook. + For example, spellchecker adds an ABC checkmark icon to the interface. + + .. image:: ../../images/admin/enable-spellcheck.png + :alt: spellcheck-interface-changes + + diff --git a/docs/images/admin/enable-spellcheck.png b/docs/images/admin/enable-spellcheck.png new file mode 100644 index 0000000..f69e32b Binary files /dev/null and b/docs/images/admin/enable-spellcheck.png differ