convert module to md docs

1 files changed, 10 insertions, 7 deletions

diff --git a/module.nix b/module.nix
index 8930a0b..e4c1de3 100644
--- a/module.nix
+++ b/module.nix
@@ -22,7 +22,7 @@ let
 in
 {
   options.services.minorskulk = with lib; {
-    enable = mkEnableOption "the minor-skulk firefox accounts server";
+    enable = mkEnableOption (mdDoc "the minor-skulk firefox accounts server");
 
     settings = mkOption {
       type = types.submodule {
@@ -32,7 +32,7 @@ in
           database_url = mkOption {
             type = types.str;
             default = "postgres:///minorskulk";
-            description = ''
+            description = mdDoc ''
               Database to use for storage. Only postgres is supported at this time.
             '';
           };
@@ -40,7 +40,7 @@ in
           location = mkOption {
             type = types.str;
             example = "https://minorskulk.my.domain";
-            description = ''
+            description = mdDoc ''
               Web location of the API endpoints.
             '';
           };
@@ -48,7 +48,7 @@ in
           token_server_location = mkOption {
             type = types.str;
             example = "https://syncstorage.my.domain";
-            description = ''
+            description = mdDoc ''
               Web location of the syncstorage token server.
             '';
           };
@@ -56,7 +56,7 @@ in
           vapid_subject = mkOption {
             type = types.str;
             example = "minorskulk@my.domain";
-            description = ''
+            description = mdDoc ''
               VAPID subject added to push messages sent over mozilla push services.
             '';
           };
@@ -64,7 +64,7 @@ in
           vapid_key = mkOption {
             type = types.path;
             example = "/etc/secrets/minorskulk-vapid-key";
-            description = ''
+            description = mdDoc ''
               VAPID key used to sign push messages sent over mozilla push services.
             '';
           };
@@ -72,12 +72,15 @@ in
           mail_from = mkOption {
             type = types.str;
             example = "minorskulk@my.domain";
-            description = ''
+            description = mdDoc ''
               Sender address for generated emails.
             '';
           };
         };
       };
+      description = mdDoc ''
+        Settings for minor-skulk. Will we written to Rocket.toml.
+      '';
     };
   };