modules/docs: options -> optionPages

Author: MattSturgeon

modules/default.nix

@@ -24,7 +24,7 @@
     ./plugins.nix
   ];
 
-  docs.options.options = {
+  docs.optionPages.options = {
     enable = true;
     optionScopes = [ ];
   };

modules/docs/default.nix

@@ -16,7 +16,7 @@
     ./platforms.nix
   ];
 
-  config.docs.options = {
+  config.docs.optionPages = {
     docs = {
       optionScopes = [ "docs" ];
       page.menu.location = [ "docs" ];

modules/docs/options.nix

@@ -18,7 +18,7 @@ let
   optionsLists = builtins.groupBy (opt: getPageFor opt.loc) (mkOptionList options);
 
   # A list of { page, scope } pairs, sorted by scope length (longest first)
-  pageScopePairs = lib.pipe config.docs.options [
+  pageScopePairs = lib.pipe config.docs.optionPages [
     (lib.mapAttrsToList (
       name: page: {
         page = name;
@@ -160,9 +160,7 @@ let
 in
 {
   options.docs = {
-    # TODO: can we name this something better than `options`?
-    # Maybe `optionsPages`?
-    options = lib.mkOption {
+    optionPages = lib.mkOption {
       type = with lib.types; lazyAttrsOf optionsPageType;
       description = ''
         A set of option scopes to include in the docs.
@@ -177,7 +175,9 @@ in
     _utils = {
       inherit optionsPageModule;
     };
-    # Define pages for each "options" attr
-    pages = builtins.mapAttrs (_: cfg: cfg.page) (lib.filterAttrs (_: v: v.enable) config.docs.options);
+    # Define pages for each "optionPages" attr
+    pages = builtins.mapAttrs (_: cfg: cfg.page) (
+      lib.filterAttrs (_: v: v.enable) config.docs.optionPages
+    );
   };
 }

modules/docs/platforms.nix

@@ -47,7 +47,7 @@ let
 in
 {
   options.docs = {
-    platforms = lib.mkOption {
+    platformPages = lib.mkOption {
       type = with lib.types; lazyAttrsOf platformPageType;
       description = ''
         A set of platform wrapper modules to include in the docs.
@@ -59,7 +59,7 @@ in
   };
 
   config.docs = {
-    platforms = {
+    platformPages = {
       "platforms/nixos" = {
         page.menu.location = [
           "platforms"
@@ -98,7 +98,9 @@ in
           source = ../../docs/platforms/standalone.md;
         };
       }
-      # Define pages for each "platforms" attr
-      // builtins.mapAttrs (_: cfg: cfg.page) (lib.filterAttrs (_: v: v.enable) config.docs.platforms);
+      # Define pages for each "platformPages" attr
+      // builtins.mapAttrs (_: cfg: cfg.page) (
+        lib.filterAttrs (_: v: v.enable) config.docs.platformPages
+      );
   };
 }

modules/plugins.nix

@@ -13,7 +13,7 @@ in
       prev ++ optional (type == "directory") (by-name + "/${name}")
     ) [ ] (readDir by-name);
 
-  docs.options =
+  docs.optionPages =
     let
       mkPluginPages =
         scope: