Merge pull request 'iwd: fix deprecation spam' (#3832) from DavHau-dave into main

Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3832

clanModules/iwd/README.md

@@ -1,6 +1,6 @@
 ---
 description = "Automatically provisions wifi credentials"
-features = [ "inventory" ]
+features = [ "inventory", "deprecated" ]
 categories = [ "Network" ]
 ---
 

clanModules/iwd/roles/default.nix

@@ -33,17 +33,7 @@ let
       };
   };
 in
-lib.warn
-  ''
-    The clan module `iwd` is deprecated and replaced by the clan service `wifi`
-    Please migrate your config to the new service (see: https://docs.clan.lol/reference/clanServices/wifi/)
-
-    To keep passwords after migrating the config, use:
-      clan vars get <your-machine> iwd.<network-name>/ssid | clan vars set <your-machine> wifi.<network-name>/network-name
-    and:
-      clan vars get <your-machine> iwd.<network-name>/password | clan vars set <your-machine> wifi.<network-name>/password
-  ''
-  {
+{
   options.clan.iwd = {
     networks = lib.mkOption {
       type = lib.types.attrsOf (
@@ -90,6 +80,18 @@ lib.warn
       # TODO: restart the iwd.service if something changes
     })
     {
+      warnings = [
+        ''
+          The clan module `iwd` is deprecated and replaced by the clan service `wifi`
+          Please migrate your config to the new service (see: https://docs.clan.lol/reference/clanServices/wifi/)
+
+          To keep passwords after migrating the config, use:
+            clan vars get <your-machine> iwd.<network-name>/ssid | clan vars set <your-machine> wifi.<network-name>/network-name
+          and:
+            clan vars get <your-machine> iwd.<network-name>/password | clan vars set <your-machine> wifi.<network-name>/password
+        ''
+      ];
+
       # disable wpa supplicant
       networking.wireless.enable = false;
 
@@ -109,4 +111,4 @@ lib.warn
       };
     }
   ];
-  }
+}

docs/nix/render_options/__init__.py

@@ -579,7 +579,7 @@ def produce_clan_modules_docs() -> None:
 !!! Warning "Deprecated"
     The `{module_name}` module is deprecated.*
 
-    Use [clanServices/{module_name}](../clanServices/{module_name}.md) instead
+    Use 'clanServices/{module_name}' or a similar successor instead
 """
         else:
             output += f"""