ci(docgen): more progress towards release of docgen api (#287)

also added _file and key as things can be overridden about the
makeWrapper module in case it looks better in the docs that way for a
particular module (might be useful for the neovim hosts options)

Author: BirdeeHub

ci/checks/all-modules-have-maintainers.nix

@@ -10,7 +10,7 @@ let
       name:
       let
         module = module_set.${name};
-        list = (self.lib.evalModule module).config.meta.maintainers;
+        list = (self.lib.evalModule module).options.meta.maintainers.definitionsWithLocations;
         check = modpath: pkgs.lib.findFirst (v: toString v.file == toString modpath) null list == null;
       in
       if !pkgs.lib.isStringLike module then false else check module

ci/docs/per-mod/default.nix

@@ -52,6 +52,7 @@ rec {
       options,
       transform ? null,
       includeCore ? true,
+      prefix ? false,
       ...
     }:
     lib.pipe
@@ -60,6 +61,7 @@ rec {
           options
           includeCore
           transform
+          prefix
           ;
       }
       [

ci/docs/per-mod/normopts.nix

@@ -5,7 +5,7 @@
 }:
 {
   options,
-  prefix ? null,
+  prefix ? false,
   transform ? null,
   includeCore ? true,
   ...
@@ -15,7 +15,7 @@ let
     options.extendModules.value or (
       _: throw "nix-wrapper-modules docgen error: the options set passed was not from a wrapper module!"
     )
-    { ${if prefix != null then "prefix" else null} = prefix; };
+    { ${if prefix == null || builtins.isList prefix then "prefix" else null} = prefix; };
 in
 let
   inherit (evaluated) options graph;

ci/docs/per-mod/rendermd.nix

@@ -10,6 +10,7 @@
   options,
   includeCore ? true,
   transform ? null,
+  prefix ? false,
   nameFromModule ?
     { file, ... }:
     lib.removeSuffix "/module.nix" (lib.removePrefix "${wlib.modulesPath}/" (toString file)),
@@ -49,6 +50,7 @@ let
     inherit
       options
       transform
+      prefix
       includeCore
       ;
   });

lib/lib.nix

@@ -197,6 +197,9 @@ in
       options = lib.setAttrByPath (optloc ++ [ name ]) (
         lib.mkOption {
           default = { };
+          description = ''
+            wrapper module for `${name}` as a submodule option
+          '';
           type = wlib.types.subWrapperModule (
             (lib.toList value)
             ++ [

modules/makeWrapper/module.nix

@@ -1,6 +1,6 @@
 let
   options_module =
-    excluded: is_top:
+    _file: excluded: is_top:
     {
       config,
       options,
@@ -11,7 +11,7 @@ let
       ...
     }:
     {
-      _file = ./module.nix;
+      inherit _file;
       options.${if !(excluded.argv0type or false) then "argv0type" else null} = lib.mkOption {
         type =
           with lib.types;
@@ -470,10 +470,11 @@ let
                   inherit wlib;
                 };
                 modules = [
-                  (options_module excluded false)
+                  (options_module _file excluded false)
                   (
                     { name, ... }:
                     {
+                      inherit _file;
                       options.enable = lib.mkOption {
                         type = lib.types.bool;
                         default = true;
@@ -573,6 +574,8 @@ in
   excluded_options = { };
   exclude_wrapper = false;
   exclude_meta = false;
+  _file = ./module.nix;
+  key = ./module.nix;
   __functor =
     self:
     {
@@ -581,9 +584,9 @@ in
       ...
     }:
     {
-      _file = ./module.nix;
-      key = ./module.nix;
-      imports = [ (options_module (self.excluded_options or { }) true) ];
+      _file = self._file or ./module.nix;
+      ${if (self.key or ./module.nix) != null then "key" else null} = self.key or ./module.nix;
+      imports = [ (options_module (self._file or ./module.nix) (self.excluded_options or { }) true) ];
       config.${if self.exclude_wrapper or false then null else "wrapperFunction"} = lib.mkDefault (
         self.wrapperFunction or (import ./. null)
       );
@@ -648,6 +651,8 @@ in
             `excluded_options = { ... };` where you may include `optionname = true`
             in order to not define that option.
 
+            `_file` and `key`: `_file` changes the value set for the modules imported when you import this module. `key` is set on the main one if not `null`.
+
             In order to change these values, you change them in the set before importing the module like so:
 
             ```nix