You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/developers/extensions.rst
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -109,9 +109,9 @@ An ExtensionApp:
109
109
110
110
- has traits.
111
111
- is configurable (from file or CLI)
112
-
- has a name (see the ``extension_name`` trait).
113
-
- has an entrypoint, ``jupyter <extension_name>``.
114
-
- can serve static content from the ``/static/<extension_name>/`` endpoint.
112
+
- has a name (see the ``name`` trait).
113
+
- has an entrypoint, ``jupyter <name>``.
114
+
- can serve static content from the ``/static/<name>/`` endpoint.
115
115
- can add new endpoints to the Jupyter Server.
116
116
117
117
The basic structure of an ExtensionApp is shown below:
@@ -124,7 +124,7 @@ The basic structure of an ExtensionApp is shown below:
124
124
classMyExtensionApp(ExtensionApp):
125
125
126
126
# -------------- Required traits --------------
127
-
extension_name="myextension"
127
+
name="myextension"
128
128
extension_url ="/myextension"
129
129
load_other_extensions =True
130
130
@@ -163,7 +163,7 @@ Methods
163
163
164
164
Properties
165
165
166
-
* ``extension_name``: the name of the extension
166
+
* ``name``: the name of the extension
167
167
* ``extension_url``: the default url for this extension—i.e. the landing page for this extension when launched from the CLI.
168
168
* ``load_other_extensions``: a boolean enabling/disabling other extensions when launching this extension directly.
169
169
@@ -174,8 +174,8 @@ Properties
174
174
175
175
* ``config``: the ExtensionApp's config object.
176
176
* ``server_config``: the ServerApp's config object.
177
-
* ``extension_name``: the name of the extension to which this handler is linked.
178
-
* ``static_url()``: a method that returns the url to static files (prefixed with ``/static/<extension_name>``).
177
+
* ``name``: the name of the extension to which this handler is linked.
178
+
* ``static_url()``: a method that returns the url to static files (prefixed with ``/static/<name>``).
179
179
180
180
Jupyter Server provides a convenient mixin class for adding these properties to any ``JupyterHandler``. For example, the basic server extension handler in the section above becomes:
181
181
@@ -202,7 +202,7 @@ Jinja templating from frontend extensions
202
202
203
203
Many Jupyter frontend applications use Jinja for basic HTML templating. Since this is common enough, Jupyter Server provides some extra mixin that integrate Jinja with Jupyter server extensions.
204
204
205
-
Use ``ExtensionAppJinjaMixin`` to automatically add a Jinja templating environment to an ``ExtensionApp``. This adds a ``<extension_name>_jinja2_env`` setting to Tornado Web Server's settings that will be used by request handlers.
205
+
Use ``ExtensionAppJinjaMixin`` to automatically add a Jinja templating environment to an ``ExtensionApp``. This adds a ``<name>_jinja2_env`` setting to Tornado Web Server's settings that will be used by request handlers.
Copy file name to clipboardExpand all lines: docs/source/operators/configuring-extensions.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ Jupyter Server looks for an extension's config file in a set of specific paths.
26
26
Extension config from file
27
27
--------------------------
28
28
29
-
Jupyter Server expects the file to be named after the extension's name like so: ``jupyter_{extension_name}_config``. For example, the Jupyter Notebook's config file is ``jupyter_notebook_config``.
29
+
Jupyter Server expects the file to be named after the extension's name like so: ``jupyter_{name}_config``. For example, the Jupyter Notebook's config file is ``jupyter_notebook_config``.
0 commit comments