panel icon indicating copy to clipboard operation
panel copied to clipboard

panel yaml file is undocumented

Open j-carson opened this issue 2 years ago • 5 comments

Thanks for contacting us! Please read and follow these instructions carefully, then delete this introductory text to keep your issue easy to read. Note that the issue tracker is NOT the place for usage questions and technical assistance; post those at Discourse instead. Issues without the required information below may be closed immediately.

ALL software version info

documentation bug - https://panel.holoviz.org/how_to/server/commandline.html

Description of expected behavior and the observed behavior

  • Observed: the panel serve command has a --use-config CONFIG option documented
  • Tried searching for documentation on how to setup a config file, but no documentation on the config file setup or example config file found
  • Tried asking on the discourse community and got no responses from anyone who has used this feature before

Config files would make it easier to organize slightly different application deployments (such as production vs development) which would be really nice, if only it were documented what I can config in a yaml file and what the file should look like.

Complete, minimal, self-contained example code that reproduces the issue

# code goes here between backticks

Stack traceback and/or browser JavaScript console output

Screenshots or screencasts of the bug in action

  • [ ] I may be interested in making a pull request to address this

j-carson avatar Oct 03 '23 17:10 j-carson

Interestingly enough, even I didn't know about this. It's something I've always considered implementing but didn't realize it already existed. Will have to investigate what it actually does and see if we can reuse it or extend it to do what we need.

philippjfr avatar Oct 04 '23 11:10 philippjfr

This issue has been mentioned on HoloViz Discourse. There might be relevant details there:

https://discourse.holoviz.org/t/panel-serve-use-config-option-is-there-a-sample-yaml-or-more-details/6091/4

holovizbot avatar May 30 '25 03:05 holovizbot

You can see how --use-config works here https://docs.bokeh.org/en/latest/docs/reference/settings.html.

Image

MarcSkovMadsen avatar May 30 '25 14:05 MarcSkovMadsen

@MarcSkovMadsen So, the config file is just for bokeh-level options and none of the panel settings https://panel.holoviz.org/api/config.html can be set via YAML?

j-carson avatar Jun 03 '25 15:06 j-carson

I would assume its a general solution that works for both Bokeh and Panel due to the way it works (settings.load_config). But that is to be tested.

MarcSkovMadsen avatar Jun 03 '25 16:06 MarcSkovMadsen