modules: various fixups for rendering docs

nix-community · Oct 11, 2023 · dc43eeb · dc43eeb
1 parent af64cc5
commit dc43eeb
Show file tree

Hide file tree

Showing 11 changed files with 37 additions and 19 deletions.
diff --git a/modules/dream2nix/core/public/interface.nix b/modules/dream2nix/core/public/interface.nix
@@ -29,6 +29,7 @@ in {
       The final result of the evaluated package.
       Contains everything that nix expects from a derivation.
       Contains fields like name, outputs, drvPath, outPath, etc.
+      Can be build with nix-build or `nix build`.
     '';
   };
 }
diff --git a/modules/dream2nix/package-func/interface.nix b/modules/dream2nix/package-func/interface.nix
@@ -15,7 +15,7 @@ in {
     };
 
     package-func.args = l.mkOption {
-      type = t.attrsOf (t.either (t.listOf t.raw) t.anything);
+      type = t.lazyAttrsOf (t.either (t.listOf t.raw) t.anything);
       description = "The arguments which will be passed to `package-func.func`";
     };
 

diff --git a/modules/dream2nix/php-composer-lock/default.nix b/modules/dream2nix/php-composer-lock/default.nix
@@ -1,5 +1,6 @@
 {
   config,
+  dream2nix,
   lib,
   ...
 }: let
@@ -28,6 +29,7 @@
 in {
   imports = [
     ./interface.nix
+    dream2nix.modules.dream2nix.mkDerivation
   ];
 
   # declare external dependencies
@@ -47,5 +49,6 @@ in {
       if cfg.composerLockFile != null
       then l.fromJSON (l.readFile cfg.composerLockFile)
       else lib.mkDefault {};
+    source = lib.mkOptionDefault config.mkDerivation.src;
   };
 }
diff --git a/modules/dream2nix/php-composer-lock/interface.nix b/modules/dream2nix/php-composer-lock/interface.nix
@@ -20,6 +20,9 @@ in {
         The composer.json file to use.
       '';
       default = cfg.source + "/composer.json";
+      defaultText = ''
+        ''${cfg.source}/composer.json
+      '';
     };
     composerJson = {
       type = t.attrs;
@@ -31,6 +34,9 @@ in {
         The composer.lock file to use.
       '';
       default = cfg.source + "/composer.lock";
+      defaultText = ''
+        ''${cfg.source}/composer.lock
+      '';
     };
     composerLock = {
       type = t.attrs;
@@ -39,7 +45,6 @@ in {
     source = {
       type = t.either t.path t.package;
       description = "Source of the package";
-      default = config.mkDerivation.src;
     };
     withDevDependencies = {
       type = t.bool;

diff --git a/modules/dream2nix/php-granular/default.nix b/modules/dream2nix/php-granular/default.nix
@@ -305,7 +305,11 @@ in {
         version:
         # the submodule for this dependency
         {...}: {
-          imports = [(commonModule name version)];
+          imports = [
+            ./interface.nix
+            (commonModule name version)
+            dream2nix.modules.dream2nix.mkDerivation
+          ];
           inherit name version;
         }
       ))

diff --git a/modules/dream2nix/php-granular/interface.nix b/modules/dream2nix/php-granular/interface.nix
@@ -10,11 +10,13 @@
 in {
   options.php-granular = l.mapAttrs (_: l.mkOption) {
     deps = {
-      type = t.attrsOf (t.attrsOf (t.submodule {
+      type = t.lazyAttrsOf (t.lazyAttrsOf (t.submodule {
         imports = [
           dream2nix.modules.dream2nix.core
-          dream2nix.modules.dream2nix.mkDerivation
-          ./interface.nix
+          # TODO: fix this
+          # putting mkDerivation here leads to an error when generating docs:
+          #   The option `php-granular.deps.<name>.<name>.version' is used but not defined.
+          # dream2nix.modules.dream2nix.mkDerivation
         ];
         _module.args = {inherit dream2nix packageSets;};
       }));

diff --git a/modules/dream2nix/pip/default.nix b/modules/dream2nix/pip/default.nix
@@ -113,7 +113,7 @@ in {
   imports = [
     commonModule
     ./interface.nix
-    ../pip-hotfixes
+    ./pip-hotfixes
   ];
 
   deps = {nixpkgs, ...}:

diff --git a/modules/dream2nix/pip-hotfixes/default.nix → ...es/dream2nix/pip/pip-hotfixes/default.nix b/modules/dream2nix/pip-hotfixes/default.nix → ...es/dream2nix/pip/pip-hotfixes/default.nix
diff --git a/modules/dream2nix/pip-hotfixes/interface.nix → .../dream2nix/pip/pip-hotfixes/interface.nix b/modules/dream2nix/pip-hotfixes/interface.nix → .../dream2nix/pip/pip-hotfixes/interface.nix
diff --git a/modules/dream2nix/rust-cargo-lock/default.nix b/modules/dream2nix/rust-cargo-lock/default.nix
@@ -23,6 +23,7 @@
 in {
   imports = [
     ./interface.nix
+    dream2nix.modules.dream2nix.mkDerivation
   ];
   rust-cargo-lock = {
     inherit dreamLock;

diff --git a/modules/flake-parts/website.nix b/modules/flake-parts/website.nix
@@ -17,7 +17,7 @@
           # "buildPythonPackage"
           # "buildRustPackage"
           # "builtins-derivation"
-          # "core"
+          "core"
           # "groups"
           # "mkDerivation"
           # "mkDerivation-sane-defaults"
@@ -30,20 +30,22 @@
           # "nodejs-package-lock"
           # "nodejs-package-lock-v3"
           # "package-func"
-          # "php-composer-lock"
-          # "php-granular"
-          # "pip"
-          # "pip-hotfixes"
-          # "rust-cargo-lock"
-          # "rust-crane"
-          # "_template"
-          # "WIP-python-pdm"
-          # "WIP-python-pyproject"
-          # "WIP-spago"
+          "php-composer-lock"
+          "php-granular"
+
+          "pip"
+          "rust-cargo-lock"
+          "WIP-python-pdm"
+          "WIP-python-pyproject"
+          "WIP-spago"
 
-          # "lock"
+          "lock"
           "mkDerivation"
           "public"
+
+          # NOT WORKING
+          # "rust-crane"
+          # "_template"
         ]) (self.modules.dream2nix))
       (name: module: {
         title = name;