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.

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

Conversation

Projects
None yet
2 participants
@dabuside
Copy link
Contributor

dabuside commented Apr 11, 2018

add the --section='common' argument infomation
fix issue #3517 (comment)

@@ -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']

This comment has been minimized.

@takluyver

takluyver Apr 11, 2018

Member

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

This comment has been minimized.

@takluyver

takluyver Apr 11, 2018

Member

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

This comment has been minimized.

@takluyver

takluyver Apr 11, 2018

Member

Can you wrap this so the lines are max 80 columns? Thanks.

@dabuside

This comment has been minimized.

Copy link
Contributor Author

dabuside commented Apr 11, 2018

have any idea to make extension only loaded in the dashboard(file browser) page? [--section='dashboard']arguments will affect notebook view as well

@takluyver

This comment has been minimized.

Copy link
Member

takluyver commented Apr 11, 2018

tree should be the name (like in the URL). The list of accepted values is here:

NBCONFIG_SECTIONS = ['common', 'notebook', 'tree', 'edit', 'terminal']

@takluyver takluyver added this to the 5.5 milestone Apr 11, 2018

@takluyver takluyver merged commit 8d1c92a into jupyter:master Apr 11, 2018

4 checks passed

codecov/patch Coverage not affected when comparing ca3e7a3...9936aa9
Details
codecov/project 75.01% (+<.01%) compared to ca3e7a3
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.