Skip to content

Commit dcad189

Browse files
committed
update docs
1 parent 5668d7e commit dcad189

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

docs/source/developers/extensions.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@ An ExtensionApp:
109109

110110
- has traits.
111111
- 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.
115115
- can add new endpoints to the Jupyter Server.
116116

117117
The basic structure of an ExtensionApp is shown below:
@@ -124,7 +124,7 @@ The basic structure of an ExtensionApp is shown below:
124124
class MyExtensionApp(ExtensionApp):
125125
126126
# -------------- Required traits --------------
127-
extension_name = "myextension"
127+
name = "myextension"
128128
extension_url = "/myextension"
129129
load_other_extensions = True
130130
@@ -163,7 +163,7 @@ Methods
163163

164164
Properties
165165

166-
* ``extension_name``: the name of the extension
166+
* ``name``: the name of the extension
167167
* ``extension_url``: the default url for this extension—i.e. the landing page for this extension when launched from the CLI.
168168
* ``load_other_extensions``: a boolean enabling/disabling other extensions when launching this extension directly.
169169

@@ -174,8 +174,8 @@ Properties
174174

175175
* ``config``: the ExtensionApp's config object.
176176
* ``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>``).
179179

180180
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:
181181

@@ -202,7 +202,7 @@ Jinja templating from frontend extensions
202202

203203
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.
204204

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

207207
.. code-block:: python
208208

docs/source/operators/configuring-extensions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Jupyter Server looks for an extension's config file in a set of specific paths.
2626
Extension config from file
2727
--------------------------
2828

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``.
3030

3131
Configuration files can be Python or JSON files.
3232

0 commit comments

Comments
 (0)