Documentation - Create overview of all environment variables

[stephanie0x00]

Describe the issue
There is currently no overview in the docs on what environment variables can be used and what each variable does.

[ammar92]

This section has been there for quite some time now

[underdarknl]

We should look into scripting to add to the CI that collects possible env-vars. Maybe someone has already made something like that.

[ammar92]

We should look into scripting to add to the CI that collects possible env-vars. Maybe someone has already made something like that.

Most of our configuration parameters can be configured via environment variables, because they're implemented via pydantic-settings models, so we use autodoc-pydantic to automatically generate documentation for them.

For Rocky it's a bit more complicated, since it's a configuration module with constants mixed with Django-related settings and our own (environment) variables. We could document them with e.g. docstrings (probably Sphinx-format style?), but we'd still need to explicitly indicate that these are environment variables.

I'm still looking for an alternative solution

[stephanie0x00]

This section has been there for quite some time now

The problem is mainly that we do not have descriptions for any of the environment variables here. I'd very much like to see that changed that each variable has an explanatory description of how it can be used and what it affects are.

[ammar92]

This section has been there for quite some time now

The problem is mainly that we do not have descriptions for any of the environment variables here. I'd very much like to see that changed that each variable has an explanatory description of how it can be used and what it affects are.

Descriptions are available when you click on any of the attributes (e.g. BYTES_DATA_DIR). I agree that some settings could be more detailed. But this seems to be a broader issue in the documentation rather than being specific to the environment variables