Show sub options of freeform types

[infinisil]

Motivation for this change

Previously if you set the freeform type (as introduced in #82743) to e.g. attrsOf (submodule ..), those submodule options wouldn't be shown in the manual.

Originally this problem was brought to my attention by @alexarice

With an option declaration like

{ lib, ... }: {
  options.foofoofoo = lib.mkOption {
    type = lib.types.submodule {
      freeformType = lib.types.attrsOf (lib.types.submodule {
        options.bar = lib.mkOption {
          description = "Freeform bar";
        };
      });
      options.qux.bar = lib.mkOption {
        description = "Qux bar";
      };
      options.bar = lib.mkOption {
        description = "Submodule bar";
      };
    };
  };
}

The manual now correctly shows

Ping @roberth

Things done

• Checked that the manual still builds
• Checked that even more complex cases like freeformType = attrsOf (attrsOf (submodule { freeformType = attrsOf ... work
• Added a test for checking that submodule options are present

[roberth]

Suggestion and it would be nice to have a simple test case for this.

[alexarice]

Just checked out the change on my code and seems to work well. Thanks @infinisil

Only nitpick is the following:

Is there a way to stop this top level package appearing in the documentation?

[infinisil]

@roberth Added a test for that

@alexarice Not possible as of now, but I'll keep this use case in mind if I happen to touch the relevant code for it :)