Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add tips #3525

Merged
merged 3 commits into from
Apr 11, 2018
Merged

add tips #3525

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82ff0fd
add tips
dabuside Apr 11, 2018
37c6ba2
add tips
dabuside Apr 11, 2018
9936aa9
warp line
dabuside Apr 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/source/extending/frontend_extensions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,11 +219,11 @@ rather than copying it, so there's no need to reinstall after changes.
To use your extension, you'll also need to **enable** it, which tells the
notebook interface to load it. You can do that with another command::

jupyter nbextension enable my_extension/main [--sys-prefix]
jupyter nbextension enable my_extension/main [--sys-prefix|--section='common']
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not mutually exclusive from the --sys-prefix option, so the normal way is to put each one in its own [square brackets].


The argument refers to the Javascript module containing your
``load_ipython_extension`` function, which is ``my_extension/main.js`` in this
example. There is a corresponding ``disable`` command to stop using an
example. The ``--section='common'`` argument will affect all pages. There is a corresponding ``disable`` command to stop using an
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should mention that the default is for the extension only to be loaded on the notebook view - that is probably what most extensions want.

extension without uninstalling it.

.. versionchanged:: 4.2
Expand Down