Add record descriptor info to plugin doc pages

[JSCU-CNI]

This PR attempts to add RecordDescriptor information of plugins to the documentation page of every plugin. Also groups namespace plugins in nested folders where applicable.

Still uncertain how to format variants of plugins. Perhaps they should be grouped differently to prevent confusing output (e.g. locale and network plugins). Preferably plugin class and function docstrings would go directly below the title of the page, followed by the CLI example.

Example pages:

[Schamper]

For your information (I'm not sure if there's a public ticket for this), the long term plan is to add support for dataclass-style declaration of record descriptors, so that you could properly attach (and extract) a docstring per field.

This is already a great start in the meantime, much appreciated!

[JSCU-CNI]

For your information (I'm not sure if there's a public ticket for this), the long term plan is to add support for dataclass-style declaration of record descriptors, so that you could properly attach (and extract) a docstring per field.

That sounds like an excellent improvement for record descriptors. Has any effort been put into this yet?

[Schamper]

Has any effort been put into this yet?

Not yet, unfortunately. The rough idea was to create a backwards compatible interface. Maybe experiment with a translation to the current scheme first (so separate RecordDescriptor and Record classes, but later on it should behave more like proper dataclasses later (descriptor and record are the same class, records are instances of the descriptor).

[EinatFox]

fox-it/flow.record#195