Skip to content

Commit

Permalink
fix documentation for voila.json location
Browse files Browse the repository at this point in the history
fix #1468
  • Loading branch information
ogiorgis committed May 14, 2024
1 parent 7596c4f commit 005e450
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/customize.md
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,7 @@ voila --preheat_kernel=True --VoilaKernelManager.default_env_variables='{"FOO":

will set the variable "FOO" in all preheated kernels.

If the pool size does not match the user's requirements, or some notebooks need to use specific environment variables..., additional settings are needed. The easiest way to change these settings is to provide a file named `voila.json` in the same folder containing the notebooks. Settings for preheating kernel ( list of notebooks does not need preheated kernels, number of kernels in pool, refilling delay, environment variables for starting kernel...) can be set under the `VoilaKernelManager` class name.
If the pool size does not match the user's requirements, or some notebooks need to use specific environment variables..., additional settings are needed. The easiest way to change these settings is to provide a file named `voila.json` in the directory where you start Voilà. Settings for preheating kernel ( list of notebooks does not need preheated kernels, number of kernels in pool, refilling delay, environment variables for starting kernel...) can be set under the `VoilaKernelManager` class name.

Here is an example of settings with explanations for preheating kernel option.

Expand Down

0 comments on commit 005e450

Please sign in to comment.