diff options
| author | Magnus Hagander | 2025-10-07 19:50:19 +0000 |
|---|---|---|
| committer | Magnus Hagander | 2025-10-07 19:50:19 +0000 |
| commit | 1183cf87df241a5d3913254d2ecb7eea9dc8ff63 (patch) | |
| tree | 9d81fd4db56256aa855decbf9bc1dcfef0206f97 | |
| parent | 5232fad84ceafcd7dc16247e096c7f4815527c6e (diff) | |
Minor documentation updates for the new settings loading scheme
| -rw-r--r-- | tools/devsetup/README.txt | 28 |
1 files changed, 18 insertions, 10 deletions
diff --git a/tools/devsetup/README.txt b/tools/devsetup/README.txt index 733a570f..01a7643c 100644 --- a/tools/devsetup/README.txt +++ b/tools/devsetup/README.txt @@ -1,23 +1,31 @@ Configuration ------------- -The traditional approach is to create a local_settings.py file under -the postgresqleu directory, a template is provided. +The simplest approach is to create a local_settings.py file under +the postgresqleu directory. A template for this is provided in the repository. -To allow out-of-module configuration, it is possible to instead -provide a python module pgeu_system_global_settings and extend -PYTHONPATH for it to be detected. Settings in there are loaded first, -in case the above mentioned local_settings.py is available, too, it +To allow out-of-module configuration, it is possible to instead or also +provide a python module pgeu_system_global_settings somewhere in +`PYTHONPATH`. Settings in there are loaded first, +in case the above mentioned `local_settings.py` is available, too, it will override global settings. -The skin usually provides skin_settings.py and allows customization -through a similar skin_local_settings.py. These again take precedence -over global settings. +If a skin is used, it usually provides a `skin_settings.py` file and allows +customization through a similar `skin_local_settings.py`. These again take +precedence over global settings. -Last, a global python module pgeu_system_override_settings is +Finally, a global python module `pgeu_system_override_settings` is attempted to be loaded. It allows overriding any settings of the pgeu-system or the skin. +In summary, the load order for settings is: + +1. Global module `pgeu_system_global_settings` +2. Local `local_settings.py` file +3. Skin `skin_settings.py` +4. Skin `skin_local_settings.py` +5. Global module `pgeu_system_override_settings` + Dependencies needed before running ---------------------------------- |