Split documentation into each file

docs/default.nix

@@ -1,32 +1,41 @@
 # with friendly help by stylix: https://github.com/danth/stylix/blob/master/docs/default.nix
-{ pkgs, build_systems, ... }:
+{
-
+  pkgs,
+  build_systems,
+  lib,
+  ...
+}:
 let
-  makeOptionsDoc =
+  makeOptionsDoc = configuration: pkgs.nixosOptionsDoc { options = configuration; };
-    configuration:
+  generateDocs = obj: ''
-    pkgs.nixosOptionsDoc {
+    touch src/${obj.fst}.md
-      inherit (configuration) options;
+    sed '/*Declared by:*/,/^$/d' <${obj.snd.optionsCommonMark} >> src/${obj.fst}.md
-
+  '';
-      # Filter out any options not beginning with `stylix`
+  summaryAppend = name: ''
-      transformOptions =
+    echo "- [${name}](${name}.md)" >> src/SUMMARY.md
-        option:
+  '';
-        option
+  system = (build_systems [ "example" ] ../example/.)."example".options;
-        // {
+  makeOptionsDocPrograms = name: pkgs.nixosOptionsDoc { options = system.mods.${name}; };
-          visible =
+  conf = makeOptionsDoc system.conf;
-            builtins.elemAt option.loc 0 != "kernel"
+  paths = builtins.readDir ../modules/programs;
-            && option.visible
+  names = lib.lists.remove "default" (
-            && (builtins.elemAt option.loc 0 == "conf" || builtins.elemAt option.loc 0 == "mods");
+    map (name: lib.strings.removeSuffix ".nix" name) (lib.attrsets.mapAttrsToList (name: _: name) paths)
-        };
+  );
-    };
+  mods = map makeOptionsDocPrograms names;
-  example = makeOptionsDoc (build_systems [ "example" ] ../example/.)."example";
+  docs = lib.strings.concatLines (map generateDocs (lib.lists.zipLists names mods));
+  summary = lib.strings.concatStringsSep " " (map summaryAppend names);
 in
 pkgs.stdenvNoCC.mkDerivation {
   name = "dashNix-book";
   src = ./.;
 
   patchPhase = ''
-    sed '/*Declared by:*/,/^$/d' <${example.optionsCommonMark} >> src/dashNix.md
+    sed '/*Declared by:*/,/^$/d' <${conf.optionsCommonMark} >> src/conf.md
+    ${docs}
+    echo "[README](README.md)\n # Options\n - [Base Config](conf.md)" >> src/SUMMARY.md
+    ${summary}
   '';
+
   buildPhase = ''
     ${pkgs.mdbook}/bin/mdbook build --dest-dir $out
   '';

docs/src/README.md

@@ -74,6 +74,7 @@ Here is a minimal required configuration.nix (the TODOs mention a required chang
   # modules
   mods = {
     # default disk config has root home boot and swap partition, overwrite if you want something different
+    drives = {
         defaultDrives.enable = false;
         extraDrives = [
           {
@@ -93,6 +94,7 @@ Here is a minimal required configuration.nix (the TODOs mention a required chang
             };
           }
         ];
+    };
     sops.enable = false;
     nextcloud.enable = false;
     hyprland.monitor = [
@@ -103,7 +105,7 @@ Here is a minimal required configuration.nix (the TODOs mention a required chang
       ",highrr,auto,1"
     ];
     # or amd, whatever you have
-    nvidia.enable = true;
+    gpu.nvidia.enable = true;
     kde_connect.enable = true;
     # TODO change this to your main resolution
     # -> this will be your login manager

docs/src/SUMMARY.md

@@ -1,6 +0,0 @@
-[README](README.md)
-
-# Options
-
-- [Options](dashNix.md)
-

docs/src/conf.md

@@ -0,0 +1 @@
+# This file handles the basic configuration for settings like language, timezone, input, cpu etc.

docs/src/mods.md

@@ -0,0 +1 @@
+# This file handles configuration of individual modules.

example/hosts/example/configuration.nix

@@ -17,6 +17,7 @@
   # modules
   mods = {
     # default disk config has root home boot and swap partition, overwrite if you want something different
+    drives = {
       defaultDrives.enable = false;
       extraDrives = [
         {
@@ -45,6 +46,7 @@
           };
         }
       ];
+    };
     sops.enable = false;
     nextcloud.enable = false;
     hyprland.monitor = [
@@ -55,7 +57,7 @@
       ",highrr,auto,1"
     ];
     # or amd, whatever you have
-    nvidia.enable = true;
+    gpu.nvidia.enable = true;
     kde_connect.enable = true;
     # TODO change this to your main resolution
     # -> this will be your login manager

flake.nix

@@ -70,6 +70,7 @@
       dashNixLib = import ./lib { inherit inputs pkgs; };
       docs = import ./docs {
         inherit inputs pkgs;
+        lib = inputs.nixpkgs.lib;
         build_systems = dashNixLib.build_systems;
       };
       dashNixInputs = inputs;

modules/programs/base_packages.nix

@@ -8,6 +8,7 @@
 }:
 {
   options.mods = {
+    base_packages = {
       default_base_packages = {
         enable = lib.mkOption {
           default = true;
@@ -28,12 +29,13 @@
         };
       };
     };
+  };
 
   config = (
     lib.optionalAttrs (options ? environment.systemPackages) {
-      environment.systemPackages = config.mods.default_base_packages.additional_packages;
+      environment.systemPackages = config.mods.base_packages.default_base_packages.additional_packages;
     }
-    // (lib.mkIf config.mods.default_base_packages.enable (
+    // (lib.mkIf config.mods.base_packages.default_base_packages.enable (
       lib.optionalAttrs (options ? environment.systemPackages) {
         environment.systemPackages = with pkgs; [
           adwaita-icon-theme

modules/programs/default.nix

@@ -18,7 +18,7 @@
     ./kde_connect.nix
     ./keepassxc.nix
     ./kitty.nix
-    ./layout.nix
+    ./xkb.nix
     ./media.nix
     ./ncspot.nix
     ./nextcloud.nix

modules/programs/drives.nix

@@ -36,6 +36,7 @@ let
 in
 {
   options.mods = {
+    drives = {
       useSwap = {
         enable = lib.mkOption {
           default = true;
@@ -82,6 +83,7 @@ in
         '';
       };
     };
+  };
 
   config = (
     lib.optionalAttrs (options ? fileSystems) {
@@ -93,9 +95,9 @@ in
               name = "/" + name;
               value = drive;
             }
-          ) config.mods.extraDrives
+          ) config.mods.drives.extraDrives
         )
-        // (lib.optionalAttrs config.mods.defaultDrives.enable) {
+        // (lib.optionalAttrs config.mods.drives.defaultDrives.enable) {
           "/" = {
             device = "/dev/disk/by-label/ROOT";
             fsType = "btrfs";
@@ -128,7 +130,7 @@ in
           };
         };
       # TODO make this convert to choice of drives -> thanks to funny types this doesn't work...
-      swapDevices = lib.mkIf config.mods.useSwap.enable [ { device = "/dev/disk/by-label/SWAP"; } ];
+      swapDevices = lib.mkIf config.mods.drives.useSwap.enable [ { device = "/dev/disk/by-label/SWAP"; } ];
     }
   );
 }

modules/programs/gpu.nix

@@ -8,6 +8,7 @@
 {
 
   options.mods = {
+    gpu = {
       nvidia.enable = lib.mkOption {
         default = false;
         example = true;
@@ -51,6 +52,7 @@
         };
       };
     };
+  };
 
   config =
     (lib.optionalAttrs (options ? hardware.graphics) {
@@ -64,11 +66,13 @@
         graphics =
           let
             amdPackages = [
-              (lib.mkIf (config.mods.intelgpu && lib.mkIf config.mods.vapi.enable) pkgs.vpl-gpu-rt)
+              (lib.mkIf (config.mods.gpu.intelgpu && lib.mkIf config.mods.gpu.vapi.enable) pkgs.vpl-gpu-rt)
-              (lib.mkIf (config.mods.intelgpu && lib.mkIf config.mods.vapi.enable) pkgs.intel-media-driver)
+              (lib.mkIf (
-              (lib.mkIf config.mods.vapi.enable pkgs.libvdpau-va-gl)
+                config.mods.gpu.intelgpu && lib.mkIf config.mods.gpu.vapi.enable
-              (lib.mkIf config.mods.vapi.enable pkgs.vaapiVdpau)
+              ) pkgs.intel-media-driver)
-              (lib.mkIf (config.mods.intelgpu || config.mods.amdgpu) pkgs.mesa.drivers)
+              (lib.mkIf config.mods.gpu.vapi.enable pkgs.libvdpau-va-gl)
+              (lib.mkIf config.mods.gpu.vapi.enable pkgs.vaapiVdpau)
+              (lib.mkIf (config.mods.gpu.intelgpu || config.mods.gpu.amdgpu) pkgs.mesa.drivers)
             ];
             rocmPackages = [
               pkgs.rocmPackages.clr.icd
@@ -80,12 +84,12 @@
             enable32Bit = lib.mkDefault true;
             extraPackages =
               amdPackages
-              ++ (lib.lists.optionals (config.mods.vapi.rocm.enable && config.mods.gpu.amdgpu) rocmPackages);
+              ++ (lib.lists.optionals (config.mods.gpu.vapi.rocm.enable && config.mods.gpu.amdgpu) rocmPackages);
           };
       };
     })
     // lib.optionalAttrs (options ? hardware.graphics) (
-      lib.mkIf config.mods.nvidia.enable {
+      lib.mkIf config.mods.gpu.nvidia.enable {
         hardware.nvidia = {
           modesetting.enable = true;
           # powerManagement.enable = false;

modules/programs/hyprland/hyprland.nix

@@ -254,7 +254,7 @@
           cursor = {
             # conversion seems to be borked right now, i want a smooth bibata :(
             enable_hyprcursor = false;
-            no_hardware_cursors = lib.mkIf config.mods.nvidia.enable true;
+            no_hardware_cursors = lib.mkIf config.mods.gpu.nvidia.enable true;
             # no_break_fs_vrr = true;
           };
 
@@ -285,10 +285,10 @@
             (lib.mkIf config.mods.hyprland.no_atomic "WLR_DRM_NO_ATOMIC,1")
             "GTK_USE_PORTAL, 1"
 
-            (lib.mkIf config.mods.nvidia.enable "LIBVA_DRIVER_NAME,nvidia")
+            (lib.mkIf config.mods.gpu.nvidia.enable "LIBVA_DRIVER_NAME,nvidia")
-            (lib.mkIf config.mods.nvidia.enable "XDG_SESSION_TYPE,wayland")
+            (lib.mkIf config.mods.gpu.nvidia.enable "XDG_SESSION_TYPE,wayland")
-            (lib.mkIf config.mods.nvidia.enable "GBM_BACKEND,nvidia-drm")
+            (lib.mkIf config.mods.gpu.nvidia.enable "GBM_BACKEND,nvidia-drm")
-            (lib.mkIf config.mods.nvidia.enable "__GLX_VENDOR_LIBRARY_NAME,nvidia")
+            (lib.mkIf config.mods.gpu.nvidia.enable "__GLX_VENDOR_LIBRARY_NAME,nvidia")
           ];
 
           layerrule = [

modules/programs/media.nix

@@ -6,7 +6,7 @@
   ...
 }:
 {
-  options.mods.media_packages = {
+  options.mods.media = {
     useBasePackages = lib.mkOption {
       default = true;
       example = false;
@@ -24,9 +24,9 @@
   };
   config = (
     lib.optionalAttrs (options ? home.packages) {
-      home.packages = config.mods.media_packages.additionalPackages;
+      home.packages = config.mods.media.additionalPackages;
     }
-    // (lib.mkIf config.mods.media_packages.useBasePackages (
+    // (lib.mkIf config.mods.media.useBasePackages (
       lib.optionalAttrs (options ? home.packages) {
         home.packages = with pkgs; [
           # base audio

result

@@ -1 +1 @@
-/nix/store/cp42vzpzj6jls43xf40m6hp7w07sg1xr-dashNix-book
+/nix/store/djp5gc4jd0g7p2waxhhcaliakn9irh7l-dashNix-book