search

voila-dashboards / voila

Voilà turns Jupyter notebooks into standalone web applications
https://voila.readthedocs.io
Other
5.41k stars 502 forks source link

can't find the list of available metadata options #927

Open 12rambau opened 3 years ago

12rambau commented 3 years ago

Problem

I use the voila dashboarding to display Python Jupyter notebooks in a cloud plateform. I realized recently that some parameters such as the theme can be passed directly in the metadata of the notebook (https://voila.readthedocs.io/en/stable/customize.html):

this is extremely useful as I can controll the way my notebook are displayed directly from the notebook. I wanted to set the following option: --show_tracebacks=True as follow but it seems that it doesn't work.

{
  "voila": {
   "show_tracebacks": "true",
   "theme": "dark"
}

where can I found a list of the available voila metadata options ?

Suggested Improvement

Add in the customizing section the list of option that can be set from notebook metadata

note

I would be happy to make a PR on this very page to make it clearer if someone can provide me with such a list

jtpio commented 3 years ago

Thanks @12rambau for opening this.

Looking at the PR that implemented that feature, it looks like only theme and template are supported for now? https://github.com/voila-dashboards/voila/pull/637

12rambau commented 3 years ago

Do you think that it would make sense to add show_tracebacks in this list ?

jtpio commented 3 years ago

At first glance I would say yes. Maybe something that can be tested and discussed in a new PR?

12rambau commented 3 years ago

I'll be glad to work on PR on this but I have several question before I start:

I assume I'll be coding something that looks like what have been done for theme and template here: https://github.com/voila-dashboards/voila/blob/487e4bf8ffb18672baa1b4f8e891a8c067bbade7/voila/handler.py#L84

But I'm not completely sure where to code it. Do I want to alter the voila_configuration attribute or is it to late in the initialization process ? Or should I introduce this modification before the init of this class ?

fkohrt commented 1 year ago

Similarly, strip_sources could be an option configured in the notebook's metadata.