Add example use for default_url traitlet

This commit is contained in:
YuviPanda
2016-11-28 22:42:10 -08:00
parent 41f8608f4e
commit 4f1f7d6b8f

View File

@@ -239,16 +239,17 @@ class Spawner(LoggingConfigurable):
""" """
).tag(config=True) ).tag(config=True)
# FIXME: Provide example of such an URL!
default_url = Unicode( default_url = Unicode(
'', '',
help=""" help="""
The URL the single-user server should start in. The URL the single-user server should start in.
You can set `notebook_dir` to `/` and then construct a URL here to allow people to navigate
the whole filesystem from their notebook, but still start in their home directory.
`{username}` will be expanded to the user's username `{username}` will be expanded to the user's username
Example uses:
- You can set `notebook_dir` to `/` and `default_url` to `/home/{username}` to allow people to
navigate the whole filesystem from their notebook, but still start in their home directory.
- You can set this to `/lab` to have JupyterLab start by default, rather than Jupyter Notebook.
""" """
).tag(config=True) ).tag(config=True)