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
Merged

add tips #3525

merged 3 commits into from Apr 11, 2018

Conversation

@dabuside
Copy link
Contributor

@dabuside 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']
Copy link
Member

@takluyver takluyver Apr 11, 2018

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].

Loading


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

@takluyver takluyver Apr 11, 2018

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.

Loading


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
Copy link
Member

@takluyver takluyver Apr 11, 2018

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.

Loading

@dabuside
Copy link
Contributor Author

@dabuside 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

Loading

@takluyver
Copy link
Member

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

Loading

@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
Loading
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants