diff --git a/modules/hardware/drive-monitor/default.nix b/modules/hardware/drive-monitor/default.nix index 444539c..895c7c5 100644 --- a/modules/hardware/drive-monitor/default.nix +++ b/modules/hardware/drive-monitor/default.nix @@ -8,7 +8,7 @@ in OnFailureMail = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Mail address where to send the error report"; + description = "Mail address where to send the error report"; default = null; example = "alarm@mail.com"; }; diff --git a/modules/services/aria2/default.nix b/modules/services/aria2/default.nix index 06a0aac..3251f11 100644 --- a/modules/services/aria2/default.nix +++ b/modules/services/aria2/default.nix @@ -15,7 +15,7 @@ in downloadDir = mkOption { type = types.path; - description = mdDoc '' + description = '' Directory to store downloaded files. ''; }; diff --git a/modules/services/backup/default.nix b/modules/services/backup/default.nix index 97647b4..db41a36 100644 --- a/modules/services/backup/default.nix +++ b/modules/services/backup/default.nix @@ -9,59 +9,59 @@ let in { options.my.services.backup = with lib; { - enable = mkEnableOption (lib.mdDoc "Borgbackup Service"); + enable = mkEnableOption "Borgbackup Service"; passwordFile = mkOption { type = types.path; - description = lib.mdDoc "Password for the backup"; + description = "Password for the backup"; example = "/run/secrets/password"; }; sshHost = mkOption { type = types.str; - description = lib.mdDoc "ssh-hostname for remote access"; + description = "ssh-hostname for remote access"; default = "u181505-sub1.your-storagebox.de"; example = "test.domain.com"; }; sshUser = mkOption { type = types.str; - description = lib.mdDoc "ssh-user for remote access"; + description = "ssh-user for remote access"; default = "u181505-sub1"; example = "max"; }; sshPort = mkOption { type = types.port; - description = lib.mdDoc "ssh-port for remote access"; + description = "ssh-port for remote access"; default = 23; example = 22; }; sshKeyFile = mkOption { type = types.path; - description = lib.mdDoc "ssh-key for remote access"; + description = "ssh-key for remote access"; example = "/run/secrets/ssh_key"; }; OnFailureNotification = mkOption { type = types.bool; - description = lib.mdDoc "whether to show a warning to all users or not"; + description = "whether to show a warning to all users or not"; default = false; }; OnFailureMail = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Mail address where to send the error report"; + description = "Mail address where to send the error report"; default = null; example = "alarm@mail.com"; }; paths = mkOption { type = with types; listOf str; - description = lib.mdDoc "additional path(s) to back up"; + description = "additional path(s) to back up"; default = [ "/" ]; example = [ "/home/user" ]; }; exclude = mkOption { type = with types; listOf str; - description = lib.mdDoc "Exclude paths matching any of the given patterns. See `borg help patterns`"; + description = "Exclude paths matching any of the given patterns. See `borg help patterns`"; default = [ ]; example = [ "/home/*/.cache" @@ -71,7 +71,7 @@ in doInit = mkOption { type = types.bool; - description = lib.mdDoc '' + description = '' Run {command}`borg init` if the specified {option}`repo` does not exist. You should set this to `false` diff --git a/modules/services/bazarr/default.nix b/modules/services/bazarr/default.nix index a5e9083..a45bf0f 100644 --- a/modules/services/bazarr/default.nix +++ b/modules/services/bazarr/default.nix @@ -11,7 +11,7 @@ in apiKeyFile = lib.mkOption { type = lib.types.path; - description = lib.mdDoc '' + description = '' File containing the api-key. ''; }; diff --git a/modules/services/home-automation/default.nix b/modules/services/home-automation/default.nix index 0f2a475..be90127 100644 --- a/modules/services/home-automation/default.nix +++ b/modules/services/home-automation/default.nix @@ -18,7 +18,7 @@ in port = lib.mkOption { type = lib.types.port; default = 8123; - description = lib.mdDoc '' + description = '' Web interface port. ''; }; @@ -35,7 +35,7 @@ in ] ''; default = [ ]; - description = mdDoc '' + description = '' List of [ components ] (https://www.home-assistant.io/integrations/) @@ -53,7 +53,7 @@ in type = types.nullOr (types.either types.float types.str); default = null; example = 52.3; - description = mdDoc '' + description = '' your location latitude. Impacts sunrise data. ''; }; @@ -62,7 +62,7 @@ in type = types.nullOr (types.either types.float types.str); default = null; example = 4.9; - description = mdDoc '' + description = '' your location longitude. Impacts sunrise data. ''; }; @@ -70,7 +70,7 @@ in elevation = mkOption { type = types.nullOr (types.either types.float types.str); default = null; - description = mdDoc '' + description = '' your location elevation. Impacts sunrise data. ''; }; @@ -78,7 +78,7 @@ in timezone = mkOption { type = types.str; default = "GMT"; - description = mdDoc '' + description = '' your timezone. ''; }; diff --git a/modules/services/matrix-bot/default.nix b/modules/services/matrix-bot/default.nix index 0ff08f2..308fc42 100644 --- a/modules/services/matrix-bot/default.nix +++ b/modules/services/matrix-bot/default.nix @@ -8,18 +8,18 @@ in enable = mkEnableOption "enable matrix forwarding bot"; Username = mkOption { type = types.str; - description = lib.mdDoc "Matrix bot name."; + description = "Matrix bot name."; example = "@bot:matrix.org"; default = "@stunkymonkey-bot:matrix.org"; }; PasswortFile = mkOption { type = types.path; - description = lib.mdDoc "Password for the bot."; + description = "Password for the bot."; example = "/run/secrets/password"; }; RoomID = mkOption { type = types.str; - description = lib.mdDoc "Matrix room id."; + description = "Matrix room id."; example = "!abcdefghijklmnopqr:matrix.org"; default = "!ZWnKiKLuQNBkBGMPCl:matrix.org"; }; diff --git a/modules/services/octoprint/default.nix b/modules/services/octoprint/default.nix index ce0fb72..bd9f0b3 100644 --- a/modules/services/octoprint/default.nix +++ b/modules/services/octoprint/default.nix @@ -12,7 +12,7 @@ in default = [ ]; defaultText = lib.literalExpression "plugins: []"; example = lib.literalExpression "plugins: with plugins; [ themeify stlviewer ]"; - description = lib.mdDoc "Additional plugins to be used. Available plugins are passed through the plugins input."; + description = "Additional plugins to be used. Available plugins are passed through the plugins input."; }; }; diff --git a/modules/services/photos/default.nix b/modules/services/photos/default.nix index 46758b8..238c4f0 100644 --- a/modules/services/photos/default.nix +++ b/modules/services/photos/default.nix @@ -6,12 +6,12 @@ let in { options.my.services.photos = { - enable = lib.mkEnableOption (lib.mdDoc "Photos gallery"); + enable = lib.mkEnableOption "Photos gallery"; secretsFile = lib.mkOption { type = lib.types.nullOr lib.types.path; default = null; - description = lib.mdDoc '' + description = '' pass secrets ''; }; @@ -19,7 +19,7 @@ in port = lib.mkOption { type = lib.types.port; default = 2283; - description = lib.mdDoc '' + description = '' Web interface port. ''; }; @@ -36,7 +36,7 @@ in type = lib.types.path; default = null; example = "/data/photos"; - description = lib.mdDoc '' + description = '' Storage path of your original media files (photos and videos) ''; }; diff --git a/modules/services/prowlarr/default.nix b/modules/services/prowlarr/default.nix index a511c8b..4d22aed 100644 --- a/modules/services/prowlarr/default.nix +++ b/modules/services/prowlarr/default.nix @@ -11,7 +11,7 @@ in apiKeyFile = lib.mkOption { type = lib.types.path; - description = lib.mdDoc '' + description = '' File containing the api-key. ''; }; diff --git a/modules/services/radarr/default.nix b/modules/services/radarr/default.nix index cdbeb9c..af7b00c 100644 --- a/modules/services/radarr/default.nix +++ b/modules/services/radarr/default.nix @@ -11,7 +11,7 @@ in apiKeyFile = lib.mkOption { type = lib.types.path; - description = lib.mdDoc '' + description = '' File containing the api-key. ''; }; diff --git a/modules/services/sonarr/default.nix b/modules/services/sonarr/default.nix index 8e5a9d3..dddb924 100644 --- a/modules/services/sonarr/default.nix +++ b/modules/services/sonarr/default.nix @@ -11,7 +11,7 @@ in apiKeyFile = lib.mkOption { type = lib.types.path; - description = lib.mdDoc '' + description = '' File containing the api-key. ''; };