ert icon indicating copy to clipboard operation
ert copied to clipboard

Potential improvements to Everest keyword reference

Open oyvindeide opened this issue 10 months ago • 0 comments

Currently we are using json_shema_for_humans to generate the keyword reference for Everest: https://github.com/equinor/ert/blob/122dae5a7d924be3f4d8d75da662911278ab04ac/docs/everest/conf.py#L51. This has some advantages:

  • Always up to date configuration
  • Examples available
  • Follows json-schema standard, so everything is handled

However it also has some drawbacks:

  • Not easy to configure
  • Readability is not the best, especially when keywords are optionally None (null)

If possible, we would like to avoid a custom implementation of this, and rely on some existing tool.

oyvindeide avatar Mar 12 '25 13:03 oyvindeide