summaryrefslogtreecommitdiffstats
path: root/nixos/modules/services/development
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2022-08-28 21:18:44 +0200
committerpennae <github@quasiparticle.net>2022-08-31 16:32:53 +0200
commitef176dcf7e76c3639571d7c6051246c8fbadf12a (patch)
tree3bb88ef3515ace2ad477e245bf347213c6055464 /nixos/modules/services/development
parent5a643387ec1234c5f25357f2ff962a84895436f6 (diff)
nixos/*: automatically convert option descriptions
conversions were done using https://github.com/pennae/nix-doc-munge using (probably) rev f34e145 running nix-doc-munge nixos/**/*.nix nix-doc-munge --import nixos/**/*.nix the tool ensures that only changes that could affect the generated manual *but don't* are committed, other changes require manual review and are discarded.
Diffstat (limited to 'nixos/modules/services/development')
-rw-r--r--nixos/modules/services/development/blackfire.nix2
-rw-r--r--nixos/modules/services/development/distccd.nix4
-rw-r--r--nixos/modules/services/development/hoogle.nix6
-rw-r--r--nixos/modules/services/development/jupyter/default.nix2
-rw-r--r--nixos/modules/services/development/jupyterhub/default.nix2
-rw-r--r--nixos/modules/services/development/rstudio-server/default.nix2
-rw-r--r--nixos/modules/services/development/zammad.nix2
7 files changed, 10 insertions, 10 deletions
diff --git a/nixos/modules/services/development/blackfire.nix b/nixos/modules/services/development/blackfire.nix
index 6b71e59d4bd5..054cef9ae80b 100644
--- a/nixos/modules/services/development/blackfire.nix
+++ b/nixos/modules/services/development/blackfire.nix
@@ -16,7 +16,7 @@ in {
options = {
services.blackfire-agent = {
- enable = lib.mkEnableOption "Blackfire profiler agent";
+ enable = lib.mkEnableOption (lib.mdDoc "Blackfire profiler agent");
settings = lib.mkOption {
description = lib.mdDoc ''
See https://blackfire.io/docs/up-and-running/configuration/agent
diff --git a/nixos/modules/services/development/distccd.nix b/nixos/modules/services/development/distccd.nix
index 7a8e780c3eb6..a3c909eb1959 100644
--- a/nixos/modules/services/development/distccd.nix
+++ b/nixos/modules/services/development/distccd.nix
@@ -8,7 +8,7 @@ in
{
options = {
services.distccd = {
- enable = mkEnableOption "distccd";
+ enable = mkEnableOption (lib.mdDoc "distccd");
allowedClients = mkOption {
type = types.listOf types.str;
@@ -84,7 +84,7 @@ in
};
stats = {
- enable = mkEnableOption "statistics reporting via HTTP server";
+ enable = mkEnableOption (lib.mdDoc "statistics reporting via HTTP server");
port = mkOption {
type = types.port;
default = 3633;
diff --git a/nixos/modules/services/development/hoogle.nix b/nixos/modules/services/development/hoogle.nix
index 399ffccabfc6..88dd01fd8aab 100644
--- a/nixos/modules/services/development/hoogle.nix
+++ b/nixos/modules/services/development/hoogle.nix
@@ -14,7 +14,7 @@ let
in {
options.services.hoogle = {
- enable = mkEnableOption "Haskell documentation server";
+ enable = mkEnableOption (lib.mdDoc "Haskell documentation server");
port = mkOption {
type = types.port;
@@ -29,11 +29,11 @@ in {
default = hp: [];
defaultText = literalExpression "hp: []";
example = literalExpression "hp: with hp; [ text lens ]";
- description = ''
+ description = lib.mdDoc ''
The Haskell packages to generate documentation for.
The option value is a function that takes the package set specified in
- the <varname>haskellPackages</varname> option as its sole parameter and
+ the {var}`haskellPackages` option as its sole parameter and
returns a list of packages.
'';
};
diff --git a/nixos/modules/services/development/jupyter/default.nix b/nixos/modules/services/development/jupyter/default.nix
index 66113ce09409..9b0178d3ea68 100644
--- a/nixos/modules/services/development/jupyter/default.nix
+++ b/nixos/modules/services/development/jupyter/default.nix
@@ -24,7 +24,7 @@ in {
meta.maintainers = with maintainers; [ aborsu ];
options.services.jupyter = {
- enable = mkEnableOption "Jupyter development server";
+ enable = mkEnableOption (lib.mdDoc "Jupyter development server");
ip = mkOption {
type = types.str;
diff --git a/nixos/modules/services/development/jupyterhub/default.nix b/nixos/modules/services/development/jupyterhub/default.nix
index bd8a5f0bd258..c0c0734cac09 100644
--- a/nixos/modules/services/development/jupyterhub/default.nix
+++ b/nixos/modules/services/development/jupyterhub/default.nix
@@ -30,7 +30,7 @@ in {
meta.maintainers = with maintainers; [ costrouc ];
options.services.jupyterhub = {
- enable = mkEnableOption "Jupyterhub development server";
+ enable = mkEnableOption (lib.mdDoc "Jupyterhub development server");
authentication = mkOption {
type = types.str;
diff --git a/nixos/modules/services/development/rstudio-server/default.nix b/nixos/modules/services/development/rstudio-server/default.nix
index 74a7cd2f4e57..bf4c7727bf74 100644
--- a/nixos/modules/services/development/rstudio-server/default.nix
+++ b/nixos/modules/services/development/rstudio-server/default.nix
@@ -21,7 +21,7 @@ in
meta.maintainers = with maintainers; [ jbedo cfhammill ];
options.services.rstudio-server = {
- enable = mkEnableOption "RStudio server";
+ enable = mkEnableOption (lib.mdDoc "RStudio server");
serverWorkingDir = mkOption {
type = types.str;
diff --git a/nixos/modules/services/development/zammad.nix b/nixos/modules/services/development/zammad.nix
index b18906f776f5..55374a0ec90e 100644
--- a/nixos/modules/services/development/zammad.nix
+++ b/nixos/modules/services/development/zammad.nix
@@ -28,7 +28,7 @@ in
options = {
services.zammad = {
- enable = mkEnableOption "Zammad, a web-based, open source user support/ticketing solution.";
+ enable = mkEnableOption (lib.mdDoc "Zammad, a web-based, open source user support/ticketing solution.");
package = mkOption {
type = types.package;