martius-lab / cluster_utils

https://cluster-utils.readthedocs.io/stable/
Other
12 stars 0 forks source link

doc: Use custom object type 'confval' for configuration #100

Closed luator closed 6 months ago

luator commented 6 months ago

This makes the rendering of the configuration page a bit nicer and, more importantly, allows to link/reference individual parameters.

Parameters can be added with

.. confval: namespace.foo: type = default_value

   [description]

and can be referenced in other parts of the documentation with

:confval:`namespace.foo`

Can probably still be improved a bit (e.g. I'd like to have a better way to mark required parameters) but I think it's already quite an improvement to before.

Example on how it looks like: image