docs: NixOS and nix-darwin option documentation

2021-01-21 23:45:52 +01:00
parent c33b1777b6
commit 5280360d6c
4 changed files with 73 additions and 8 deletions
@@ -36,7 +36,7 @@ in
    home-manager = {
      useUserPackages = mkEnableOption ''
        installation of user packages through the
-        <option>users.users.‹name?›.packages</option> option.
+        <option>users.users.&lt;name?&gt;.packages</option> option.
      '';

      useGlobalPkgs = mkEnableOption ''
@@ -60,6 +60,9 @@ in
      users = mkOption {
        type = types.attrsOf hmModule;
        default = {};
+        # Set as not visible to prevent the entire submodule being included in
+        # the documentation.
+        visible = false;
        description = ''
          Per-user Home Manager configuration.
        '';