treewide: remove usage of 'mdDoc'

This commit is contained in:
Felix Buehler 2024-12-30 12:01:57 +01:00
parent e38838e7c3
commit 95b21fdcbe
11 changed files with 31 additions and 31 deletions

View file

@ -8,7 +8,7 @@ in
OnFailureMail = mkOption { OnFailureMail = mkOption {
type = types.nullOr types.str; 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; default = null;
example = "alarm@mail.com"; example = "alarm@mail.com";
}; };

View file

@ -15,7 +15,7 @@ in
downloadDir = mkOption { downloadDir = mkOption {
type = types.path; type = types.path;
description = mdDoc '' description = ''
Directory to store downloaded files. Directory to store downloaded files.
''; '';
}; };

View file

@ -9,59 +9,59 @@ let
in in
{ {
options.my.services.backup = with lib; { options.my.services.backup = with lib; {
enable = mkEnableOption (lib.mdDoc "Borgbackup Service"); enable = mkEnableOption "Borgbackup Service";
passwordFile = mkOption { passwordFile = mkOption {
type = types.path; type = types.path;
description = lib.mdDoc "Password for the backup"; description = "Password for the backup";
example = "/run/secrets/password"; example = "/run/secrets/password";
}; };
sshHost = mkOption { sshHost = mkOption {
type = types.str; type = types.str;
description = lib.mdDoc "ssh-hostname for remote access"; description = "ssh-hostname for remote access";
default = "u181505-sub1.your-storagebox.de"; default = "u181505-sub1.your-storagebox.de";
example = "test.domain.com"; example = "test.domain.com";
}; };
sshUser = mkOption { sshUser = mkOption {
type = types.str; type = types.str;
description = lib.mdDoc "ssh-user for remote access"; description = "ssh-user for remote access";
default = "u181505-sub1"; default = "u181505-sub1";
example = "max"; example = "max";
}; };
sshPort = mkOption { sshPort = mkOption {
type = types.port; type = types.port;
description = lib.mdDoc "ssh-port for remote access"; description = "ssh-port for remote access";
default = 23; default = 23;
example = 22; example = 22;
}; };
sshKeyFile = mkOption { sshKeyFile = mkOption {
type = types.path; type = types.path;
description = lib.mdDoc "ssh-key for remote access"; description = "ssh-key for remote access";
example = "/run/secrets/ssh_key"; example = "/run/secrets/ssh_key";
}; };
OnFailureNotification = mkOption { OnFailureNotification = mkOption {
type = types.bool; 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; default = false;
}; };
OnFailureMail = mkOption { OnFailureMail = mkOption {
type = types.nullOr types.str; 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; default = null;
example = "alarm@mail.com"; example = "alarm@mail.com";
}; };
paths = mkOption { paths = mkOption {
type = with types; listOf str; type = with types; listOf str;
description = lib.mdDoc "additional path(s) to back up"; description = "additional path(s) to back up";
default = [ "/" ]; default = [ "/" ];
example = [ "/home/user" ]; example = [ "/home/user" ];
}; };
exclude = mkOption { exclude = mkOption {
type = with types; listOf str; 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 = [ ]; default = [ ];
example = [ example = [
"/home/*/.cache" "/home/*/.cache"
@ -71,7 +71,7 @@ in
doInit = mkOption { doInit = mkOption {
type = types.bool; type = types.bool;
description = lib.mdDoc '' description = ''
Run {command}`borg init` if the Run {command}`borg init` if the
specified {option}`repo` does not exist. specified {option}`repo` does not exist.
You should set this to `false` You should set this to `false`

View file

@ -11,7 +11,7 @@ in
apiKeyFile = lib.mkOption { apiKeyFile = lib.mkOption {
type = lib.types.path; type = lib.types.path;
description = lib.mdDoc '' description = ''
File containing the api-key. File containing the api-key.
''; '';
}; };

View file

@ -18,7 +18,7 @@ in
port = lib.mkOption { port = lib.mkOption {
type = lib.types.port; type = lib.types.port;
default = 8123; default = 8123;
description = lib.mdDoc '' description = ''
Web interface port. Web interface port.
''; '';
}; };
@ -35,7 +35,7 @@ in
] ]
''; '';
default = [ ]; default = [ ];
description = mdDoc '' description = ''
List List
of [ components ] of [ components ]
(https://www.home-assistant.io/integrations/) (https://www.home-assistant.io/integrations/)
@ -53,7 +53,7 @@ in
type = types.nullOr (types.either types.float types.str); type = types.nullOr (types.either types.float types.str);
default = null; default = null;
example = 52.3; example = 52.3;
description = mdDoc '' description = ''
your location latitude. Impacts sunrise data. your location latitude. Impacts sunrise data.
''; '';
}; };
@ -62,7 +62,7 @@ in
type = types.nullOr (types.either types.float types.str); type = types.nullOr (types.either types.float types.str);
default = null; default = null;
example = 4.9; example = 4.9;
description = mdDoc '' description = ''
your location longitude. Impacts sunrise data. your location longitude. Impacts sunrise data.
''; '';
}; };
@ -70,7 +70,7 @@ in
elevation = mkOption { elevation = mkOption {
type = types.nullOr (types.either types.float types.str); type = types.nullOr (types.either types.float types.str);
default = null; default = null;
description = mdDoc '' description = ''
your location elevation. Impacts sunrise data. your location elevation. Impacts sunrise data.
''; '';
}; };
@ -78,7 +78,7 @@ in
timezone = mkOption { timezone = mkOption {
type = types.str; type = types.str;
default = "GMT"; default = "GMT";
description = mdDoc '' description = ''
your timezone. your timezone.
''; '';
}; };

View file

@ -8,18 +8,18 @@ in
enable = mkEnableOption "enable matrix forwarding bot"; enable = mkEnableOption "enable matrix forwarding bot";
Username = mkOption { Username = mkOption {
type = types.str; type = types.str;
description = lib.mdDoc "Matrix bot name."; description = "Matrix bot name.";
example = "@bot:matrix.org"; example = "@bot:matrix.org";
default = "@stunkymonkey-bot:matrix.org"; default = "@stunkymonkey-bot:matrix.org";
}; };
PasswortFile = mkOption { PasswortFile = mkOption {
type = types.path; type = types.path;
description = lib.mdDoc "Password for the bot."; description = "Password for the bot.";
example = "/run/secrets/password"; example = "/run/secrets/password";
}; };
RoomID = mkOption { RoomID = mkOption {
type = types.str; type = types.str;
description = lib.mdDoc "Matrix room id."; description = "Matrix room id.";
example = "!abcdefghijklmnopqr:matrix.org"; example = "!abcdefghijklmnopqr:matrix.org";
default = "!ZWnKiKLuQNBkBGMPCl:matrix.org"; default = "!ZWnKiKLuQNBkBGMPCl:matrix.org";
}; };

View file

@ -12,7 +12,7 @@ in
default = [ ]; default = [ ];
defaultText = lib.literalExpression "plugins: []"; defaultText = lib.literalExpression "plugins: []";
example = lib.literalExpression "plugins: with plugins; [ themeify stlviewer ]"; 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.";
}; };
}; };

View file

@ -6,12 +6,12 @@ let
in in
{ {
options.my.services.photos = { options.my.services.photos = {
enable = lib.mkEnableOption (lib.mdDoc "Photos gallery"); enable = lib.mkEnableOption "Photos gallery";
secretsFile = lib.mkOption { secretsFile = lib.mkOption {
type = lib.types.nullOr lib.types.path; type = lib.types.nullOr lib.types.path;
default = null; default = null;
description = lib.mdDoc '' description = ''
pass secrets pass secrets
''; '';
}; };
@ -19,7 +19,7 @@ in
port = lib.mkOption { port = lib.mkOption {
type = lib.types.port; type = lib.types.port;
default = 2283; default = 2283;
description = lib.mdDoc '' description = ''
Web interface port. Web interface port.
''; '';
}; };
@ -36,7 +36,7 @@ in
type = lib.types.path; type = lib.types.path;
default = null; default = null;
example = "/data/photos"; example = "/data/photos";
description = lib.mdDoc '' description = ''
Storage path of your original media files (photos and videos) Storage path of your original media files (photos and videos)
''; '';
}; };

View file

@ -11,7 +11,7 @@ in
apiKeyFile = lib.mkOption { apiKeyFile = lib.mkOption {
type = lib.types.path; type = lib.types.path;
description = lib.mdDoc '' description = ''
File containing the api-key. File containing the api-key.
''; '';
}; };

View file

@ -11,7 +11,7 @@ in
apiKeyFile = lib.mkOption { apiKeyFile = lib.mkOption {
type = lib.types.path; type = lib.types.path;
description = lib.mdDoc '' description = ''
File containing the api-key. File containing the api-key.
''; '';
}; };

View file

@ -11,7 +11,7 @@ in
apiKeyFile = lib.mkOption { apiKeyFile = lib.mkOption {
type = lib.types.path; type = lib.types.path;
description = lib.mdDoc '' description = ''
File containing the api-key. File containing the api-key.
''; '';
}; };