1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-09 03:55:44 +03:00

nixos: remove all uses of lib.mdDoc

these changes were generated with nixq 0.0.2, by running

  nixq ">> lib.mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
  nixq ">> mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
  nixq ">> Inherit >> mdDoc[remove]" --batchmode nixos/**.nix

two mentions of the mdDoc function remain in nixos/, both of which
are inside of comments.

Since lib.mdDoc is already defined as just id, this commit is a no-op as
far as Nix (and the built manual) is concerned.
This commit is contained in:
stuebinm 2024-04-13 14:54:15 +02:00 committed by Jonathan Ringer
parent 1dd996e59a
commit 6afb255d97
1701 changed files with 13694 additions and 13865 deletions

View file

@ -95,12 +95,12 @@ in {
options.services.home-assistant = {
# Running home-assistant on NixOS is considered an installation method that is unsupported by the upstream project.
# https://github.com/home-assistant/architecture/blob/master/adr/0012-define-supported-installation-method.md#decision
enable = mkEnableOption (lib.mdDoc "Home Assistant. Please note that this installation method is unsupported upstream");
enable = mkEnableOption "Home Assistant. Please note that this installation method is unsupported upstream";
configDir = mkOption {
default = "/var/lib/hass";
type = types.path;
description = lib.mdDoc "The config directory, where your {file}`configuration.yaml` is located.";
description = "The config directory, where your {file}`configuration.yaml` is located.";
};
defaultIntegrations = mkOption {
@ -164,7 +164,7 @@ in {
"wled"
]
'';
description = lib.mdDoc ''
description = ''
List of [components](https://www.home-assistant.io/integrations/) that have their dependencies included in the package.
The component name can be found in the URL, for example `https://www.home-assistant.io/integrations/ffmpeg/` would map to `ffmpeg`.
@ -183,7 +183,7 @@ in {
psycopg2
];
'';
description = lib.mdDoc ''
description = ''
List of packages to add to propagatedBuildInputs.
A popular example is `python3Packages.psycopg2`
@ -199,7 +199,7 @@ in {
prometheus_sensor
];
'';
description = lib.mdDoc ''
description = ''
List of custom component packages to install.
Available components can be found below `pkgs.home-assistant-custom-components`.
@ -215,7 +215,7 @@ in {
mini-media-player
];
'';
description = lib.mdDoc ''
description = ''
List of custom lovelace card packages to load as lovelace resources.
Available cards can be found below `pkgs.home-assistant-custom-lovelace-modules`.
@ -240,7 +240,7 @@ in {
type = types.nullOr types.str;
default = null;
example = "Home";
description = lib.mdDoc ''
description = ''
Name of the location where Home Assistant is running.
'';
};
@ -249,7 +249,7 @@ in {
type = types.nullOr (types.either types.float types.str);
default = null;
example = 52.3;
description = lib.mdDoc ''
description = ''
Latitude of your location required to calculate the time the sun rises and sets.
'';
};
@ -258,7 +258,7 @@ in {
type = types.nullOr (types.either types.float types.str);
default = null;
example = 4.9;
description = lib.mdDoc ''
description = ''
Longitude of your location required to calculate the time the sun rises and sets.
'';
};
@ -267,7 +267,7 @@ in {
type = types.nullOr (types.enum [ "metric" "imperial" ]);
default = null;
example = "metric";
description = lib.mdDoc ''
description = ''
The unit system to use. This also sets temperature_unit, Celsius for Metric and Fahrenheit for Imperial.
'';
};
@ -276,7 +276,7 @@ in {
type = types.nullOr (types.enum [ "C" "F" ]);
default = null;
example = "C";
description = lib.mdDoc ''
description = ''
Override temperature unit set by unit_system. `C` for Celsius, `F` for Fahrenheit.
'';
};
@ -288,7 +288,7 @@ in {
config.time.timeZone or null
'';
example = "Europe/Amsterdam";
description = lib.mdDoc ''
description = ''
Pick your time zone from the column TZ of Wikipedias [list of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
'';
};
@ -303,7 +303,7 @@ in {
"::"
];
example = "::1";
description = lib.mdDoc ''
description = ''
Only listen to incoming requests on specific IP/host. The default listed assumes support for IPv4 and IPv6.
'';
};
@ -311,7 +311,7 @@ in {
server_port = mkOption {
default = 8123;
type = types.port;
description = lib.mdDoc ''
description = ''
The port on which to listen.
'';
};
@ -330,7 +330,7 @@ in {
else "storage";
'';
example = "yaml";
description = lib.mdDoc ''
description = ''
In what mode should the main Lovelace panel be, `yaml` or `storage` (UI managed).
'';
};
@ -354,7 +354,7 @@ in {
feedreader.urls = [ "https://nixos.org/blogs.xml" ];
}
'';
description = lib.mdDoc ''
description = ''
Your {file}`configuration.yaml` as a Nix attribute set.
YAML functions like [secrets](https://www.home-assistant.io/docs/configuration/secrets/)
@ -369,7 +369,7 @@ in {
configWritable = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc ''
description = ''
Whether to make {file}`configuration.yaml` writable.
This will allow you to edit it from Home Assistant's web interface.
@ -396,7 +396,7 @@ in {
} ];
}
'';
description = lib.mdDoc ''
description = ''
Your {file}`ui-lovelace.yaml` as a Nix attribute set.
Setting this option will automatically set `lovelace.mode` to `yaml`.
@ -407,7 +407,7 @@ in {
lovelaceConfigWritable = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc ''
description = ''
Whether to make {file}`ui-lovelace.yaml` writable.
This will allow you to edit it from Home Assistant's web interface.
@ -439,7 +439,7 @@ in {
];
}
'';
description = lib.mdDoc ''
description = ''
The Home Assistant package to use.
'';
};
@ -447,7 +447,7 @@ in {
openFirewall = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc "Whether to open the firewall for the specified port.";
description = "Whether to open the firewall for the specified port.";
};
};