treewide: use mdDoc for descriptions

Enable markdown syntax (instead of docbook) for descriptions.
This only affects external doc tooling that renders the descriptions.
This commit is contained in:
Erik Arvstedt
2022-12-18 20:01:52 +01:00
parent a9c1995ed9
commit 109dccca27
33 changed files with 292 additions and 292 deletions
+3 -3
View File
@@ -10,7 +10,7 @@ with lib;
noConnections = mkOption {
type = types.bool;
default = !config.test.container.enableWAN;
description = ''
description = mdDoc ''
Whether services should be configured to not connect to external hosts.
This can silence some warnings while running the test in an offline environment.
'';
@@ -18,9 +18,9 @@ with lib;
data = mkOption {
type = types.attrs;
default = {};
description = ''
description = mdDoc ''
Attrs that are available in the Python test script under the global
dictionary variable 'test_data'. The data is exported via JSON.
dictionary variable {var}`test_data`. The data is exported via JSON.
'';
};
extraTestScript = mkOption {