-
Notifications
You must be signed in to change notification settings - Fork 5k
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.
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
add tips #3525
Conversation
@@ -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'] |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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.
|
||
The argument refers to the Javascript module containing your | ||
``load_ipython_extension`` function, which is ``my_extension/main.js`` in this | ||
example. The ``--section='common'`` argument will affect all pages. There is a corresponding ``disable`` command to stop using an | ||
example. The ``--section='common'`` argument will affect all pages, by default it will be loaded on the notebook view only. There is a corresponding ``disable`` command to stop using an |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you wrap this so the lines are max 80 columns? Thanks.
have any idea to make extension only loaded in the dashboard(file browser) page? [--section='dashboard']arguments will affect notebook view as well |
notebook/notebook/nbextensions.py Line 37 in f69ce9f
|
add the
--section='common'
argument infomationfix issue #3517 (comment)