Skip to content

Commit

Permalink
Merge pull request jupyter-server#420 from Zsailer/docs-file_to_run
Browse files Browse the repository at this point in the history
Add file_to_run to server extension docs
  • Loading branch information
blink1073 authored Feb 19, 2021
2 parents f8ac713 + 03f438c commit 2a6d8bd
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/source/developers/extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ The basic structure of an ExtensionApp is shown below:
name = "myextension"
default_url = "/myextension"
load_other_extensions = True
file_url_prefix = "/render"
# --- ExtensionApp traits you can configure ---
static_paths = [...]
Expand Down Expand Up @@ -167,8 +168,9 @@ Methods
Properties

* ``name``: the name of the extension
* ``default_url``: the default url for this extension—i.e. the landing page for this extension when launched from the CLI.
* ``default_url``: the default URL for this extension—i.e. the landing page for this extension when launched from the CLI.
* ``load_other_extensions``: a boolean enabling/disabling other extensions when launching this extension directly.
* ``file_url_prefix``: the prefix URL added when opening a document directly from the command line. For example, classic Notebook uses ``/notebooks`` to open a document at http://localhost:8888/notebooks/path/to/notebook.ipynb.

``ExtensionApp`` request handlers
---------------------------------
Expand Down

0 comments on commit 2a6d8bd

Please sign in to comment.