refactor(extranix): move module declaration and give descriptions

REUSE.toml

@@ -32,7 +32,7 @@ precedence = "closest"
 [[annotations]]
 SPDX-FileCopyrightText = "2024 Lubin Bailly <lubin.bailly@dgnum.eu>"
 SPDX-License-Identifier = "EUPL-1.2"
-path = ["machines/nixos/compute01/search/0001-revert-don-t-parse-md-in-js.patch", "machines/nixos/compute01/search/0002-chore-remove-useless-dependencies.patch", "machines/nixos/compute01/search/0003-feat-separate-HTML-description-of-MD-description.patch", "machines/nixos/compute01/search/0004-fix-indentation-of-ul.patch", "machines/nixos/compute01/search/0005-feat-match-all-substring-by-default.patch"]
+path = ["modules/nixos/extranix/0001-revert-don-t-parse-md-in-js.patch", "modules/nixos/extranix/0002-chore-remove-useless-dependencies.patch", "modules/nixos/extranix/0003-feat-separate-HTML-description-of-MD-description.patch", "modules/nixos/extranix/0004-fix-indentation-of-ul.patch", "modules/nixos/extranix/0005-feat-match-all-substring-by-default.patch"]
 precedence = "closest"
 
 [[annotations]]

default.nix

@@ -103,11 +103,11 @@ let
       }
       {
         path = [
-          "machines/nixos/compute01/search/0001-revert-don-t-parse-md-in-js.patch"
+          "modules/nixos/extranix/0001-revert-don-t-parse-md-in-js.patch"
-          "machines/nixos/compute01/search/0002-chore-remove-useless-dependencies.patch"
+          "modules/nixos/extranix/0002-chore-remove-useless-dependencies.patch"
-          "machines/nixos/compute01/search/0003-feat-separate-HTML-description-of-MD-description.patch"
+          "modules/nixos/extranix/0003-feat-separate-HTML-description-of-MD-description.patch"
-          "machines/nixos/compute01/search/0004-fix-indentation-of-ul.patch"
+          "modules/nixos/extranix/0004-fix-indentation-of-ul.patch"
-          "machines/nixos/compute01/search/0005-feat-match-all-substring-by-default.patch"
+          "modules/nixos/extranix/0005-feat-match-all-substring-by-default.patch"
         ];
         copyright = "2024 Lubin Bailly <lubin.bailly@dgnum.eu>";
       }

machines/nixos/compute01/search/default.nix

@@ -12,9 +12,6 @@ let
   host = "search.infra.dgnum.eu";
 in
 {
-  imports = [
-    ./module.nix
-  ];
   services = {
     nginx.virtualHosts.${host} = {
       enableACME = true;

modules/nixos/default.nix

@@ -32,6 +32,7 @@
       "dgn-vm-variant"
       "dgn-web"
       "django-apps"
+      "extranix"
     ])
     ++ [
       "${sources.agenix}/modules/age.nix"

modules/nixos/extranix/default.nix

@@ -136,13 +136,25 @@ in
             specialArgs = mkOption {
               type = types.attrs;
               default = { };
+              description = ''
+                Special arguments to give to evalModules.
+              '';
             };
             paths = mkOption {
               type = types.listOf types.deferredModule;
+              description = ''
+                Modules to from which to document options.
+              '';
             };
             ignored-modules = mkOption {
               type = types.listOf types.deferredModule;
               default = [ ];
+              description = ''
+                Modules required to make modules of `paths` valid.
+              '';
+              example = ''
+                import "''${infra-modulesPath}/module-list.nix"
+              '';
             };
             path-translations = mkOption {
               type =
@@ -150,26 +162,71 @@ in
                   path-mod.options = {
                     base = mkOption {
                       type = types.path;
+                      description = ''
+                        Base path of some module files to be documented.
+                      '';
                     };
                     url = mkOption {
                       type = types.str;
+                      description = ''
+                        Url root to use for files on this path.
+                      '';
                     };
                   };
                 in
                 types.listOf (types.submodule path-mod);
+              description = ''
+                Rules to convert file paths to urls in the documentation to indicate where
+                the option is declared.
+              '';
             };
           };
         in
         types.attrsOf (types.submodule module-mod);
+      description = ''
+        Sets of modules to be documented separately. The identifier to give for
+        `settings.params.release_current_stable` (which is the default module shown) is the key after
+        passing through `sanitizeDerivationName`.
+      '';
     };
     settings = mkOption {
       inherit (yaml) type;
+      description = ''
+        Settings for the `config.yaml` for the hugo instantiation.
+      '';
+      example = {
+        baseUrl = "https://example.org/";
+        title = "Module documentation";
+        languageCode = "en-us";
+        params = {
+          release_current_stable = "Some-Module";
+          logo = "logo.png";
+          footer_credits_line = ''
+            Based on <a href="https://github.com/mipmip/home-manager-option-search">Home Manager Option Search</a>
+          '';
+          footer_copyright_line = ''
+            Made by catvayor for the <a href="https://dgnum.eu">DGNum</a>.
+          '';
+          main_menu = [
+            {
+              name = ''Sources'';
+              url = "https://git.example.org/";
+            }
+          ];
+        };
+      };
     };
     static-data = mkOption {
       type = types.path;
+      description = ''
+        Static files for the website. Should have `images/favicon.png` for favicon.
+      '';
     };
     host = mkOption {
       type = types.str;
+      description = ''
+        Hostname of the service.
+      '';
     };
   };
   config = mkIf cfg.enable {