From c707d4f552bb91512c1df677b2d33ec6000c5230 Mon Sep 17 00:00:00 2001 From: Emily Date: Wed, 19 Jul 2023 21:38:38 +0100 Subject: [PATCH] docs: hide `_module.*` from NixOS/nix-darwin docs These are already documented in the system-level manuals and have no particular relevance to the `home-manager.*` options. --- docs/default.nix | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/default.nix b/docs/default.nix index c6c92bd2..98dce1d9 100644 --- a/docs/default.nix +++ b/docs/default.nix @@ -46,9 +46,13 @@ let hmPath = toString ./..; - buildOptionsDocs = args@{ modules, ... }: - pkgs.buildPackages.nixosOptionsDoc ({ - options = (lib.evalModules { inherit modules; }).options; + buildOptionsDocs = args@{ modules, includeModuleSystemOptions ? true, ... }: + let options = (lib.evalModules { inherit modules; }).options; + in pkgs.buildPackages.nixosOptionsDoc ({ + options = if includeModuleSystemOptions then + options + else + builtins.removeAttrs options [ "_module" ]; transformOptions = opt: opt // { # Clean up declaration sites to not refer to the Home Manager @@ -64,7 +68,7 @@ let else decl) opt.declarations; }; - } // builtins.removeAttrs args [ "modules" ]); + } // builtins.removeAttrs args [ "modules" "includeModuleSystemOptions" ]); hmOptionsDocs = buildOptionsDocs { modules = import ../modules/modules.nix { @@ -76,12 +80,14 @@ let nixosOptionsDocs = buildOptionsDocs { modules = [ ../nixos scrubbedPkgsModule dontCheckDefinitions ]; + includeModuleSystemOptions = false; variablelistId = "nixos-options"; optionIdPrefix = "nixos-opt-"; }; nixDarwinOptionsDocs = buildOptionsDocs { modules = [ ../nix-darwin scrubbedPkgsModule dontCheckDefinitions ]; + includeModuleSystemOptions = false; variablelistId = "nix-darwin-options"; optionIdPrefix = "nix-darwin-opt-"; };