Question from @sergei-maertens via slack:

https://odrc.readthedocs.io/en/latest/installation/config.html -> this is auto-generated via the management command from OAF. is there a way to exclude some settings? e.g. we don't use django.contrib.sites so I don't want SITE_ID to be mentioned. We're also not supporting outgoing email for now

We could add something like --exclude-var to the management command (https://github.com/maykinmedia/open-api-framework/blob/main/open_api_framework/management/commands/generate_envvar_docs.py#L32-L36) to exclude individual variables/settings

@sergei-maertens would this work for you?

TODO:

• Add maykin-common to the dependencies of open-api-framework
• Move the config util from open-api-framework to maykin-common
• Add sphinx directives for the following (similar sphinx directives are part of django-setup-configuration, so the setup there could be used as inspiration
  • :config_group:`param_name` to show the docs for a single envvar (should be possible to override the default help text in case a custom default is used for example
  • :config_group:`group_name` to show the envvar docs for a specific group (should have :members: and :exclude: options that function as allow and denylists for specific envvars
  • :config_all_params: to display all envvar groups (similar to https://github.com/maykinmedia/django-setup-configuration/blob/main/django_setup_configuration/documentation/setup_config_usage.py)
  • :config_usage: to describe how to specify envvars
• Add documentation on how to use these sphinx directives
• Replace the existing documentation in the components to use the new directive(s)
  • Open Zaak
  • Open Notificaties Feature/oaf 83 refactor envvar docs open-zaak/open-notificaties#324
  • Objects
  • Open Klant Feature/oaf 83 refactor envvar docs open-klant#498
  • Referentielijsten
  • Open Product
  • Open Werk
  • Open Inkomen
  • Open Inburgering