diff options
author | pennae <github@quasiparticle.net> | 2022-08-03 22:46:41 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2022-08-03 22:46:41 +0200 |
commit | 61e93df1891972bae3e0c97a477bd44e8a477aa0 (patch) | |
tree | 4285c1d22db537fb02baf1e978eb4434b0276b0c /nixos/modules/services/matrix | |
parent | 645cfa59ac5690187eac40ef2ac67381668acecc (diff) | |
download | nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.gz nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.bz2 nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.lz nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.xz nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.zst nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.zip |
nixos/*: automatically convert option docs to MD
once again using nix-doc-munge (https://github.com/pennae/nix-doc-munge/commit/69d080323ae27c0d8da3967c62b925a9aedb2828)
Diffstat (limited to 'nixos/modules/services/matrix')
-rw-r--r-- | nixos/modules/services/matrix/appservice-discord.nix | 10 | ||||
-rw-r--r-- | nixos/modules/services/matrix/mautrix-facebook.nix | 8 | ||||
-rw-r--r-- | nixos/modules/services/matrix/mautrix-telegram.nix | 8 |
3 files changed, 13 insertions, 13 deletions
diff --git a/nixos/modules/services/matrix/appservice-discord.nix b/nixos/modules/services/matrix/appservice-discord.nix index 87a706ae95e..c72a2123a92 100644 --- a/nixos/modules/services/matrix/appservice-discord.nix +++ b/nixos/modules/services/matrix/appservice-discord.nix @@ -40,16 +40,16 @@ in { }; } ''; - description = '' - <filename>config.yaml</filename> configuration as a Nix attribute set. + description = lib.mdDoc '' + {file}`config.yaml` configuration as a Nix attribute set. Configuration options should match those described in - <link xlink:href="https://github.com/Half-Shot/matrix-appservice-discord/blob/master/config/config.sample.yaml">config.sample.yaml</link>. + [config.sample.yaml](https://github.com/Half-Shot/matrix-appservice-discord/blob/master/config/config.sample.yaml). - <option>config.bridge.domain</option> and <option>config.bridge.homeserverUrl</option> + {option}`config.bridge.domain` and {option}`config.bridge.homeserverUrl` should be set to match the public host name of the Matrix homeserver for webhooks and avatars to work. - Secret tokens should be specified using <option>environmentFile</option> + Secret tokens should be specified using {option}`environmentFile` instead of this world-readable attribute set. ''; }; diff --git a/nixos/modules/services/matrix/mautrix-facebook.nix b/nixos/modules/services/matrix/mautrix-facebook.nix index 384a4f4a706..dfdf6e25021 100644 --- a/nixos/modules/services/matrix/mautrix-facebook.nix +++ b/nixos/modules/services/matrix/mautrix-facebook.nix @@ -75,12 +75,12 @@ in { }; } ''; - description = '' - <filename>config.yaml</filename> configuration as a Nix attribute set. + description = lib.mdDoc '' + {file}`config.yaml` configuration as a Nix attribute set. Configuration options should match those described in - <link xlink:href="https://github.com/mautrix/facebook/blob/master/mautrix_facebook/example-config.yaml">example-config.yaml</link>. + [example-config.yaml](https://github.com/mautrix/facebook/blob/master/mautrix_facebook/example-config.yaml). - Secret tokens should be specified using <option>environmentFile</option> + Secret tokens should be specified using {option}`environmentFile` instead of this world-readable attribute set. ''; }; diff --git a/nixos/modules/services/matrix/mautrix-telegram.nix b/nixos/modules/services/matrix/mautrix-telegram.nix index 492ed1b24bc..196100a531a 100644 --- a/nixos/modules/services/matrix/mautrix-telegram.nix +++ b/nixos/modules/services/matrix/mautrix-telegram.nix @@ -78,12 +78,12 @@ in { }; } ''; - description = '' - <filename>config.yaml</filename> configuration as a Nix attribute set. + description = lib.mdDoc '' + {file}`config.yaml` configuration as a Nix attribute set. Configuration options should match those described in - <link xlink:href="https://github.com/tulir/mautrix-telegram/blob/master/example-config.yaml">example-config.yaml</link>. + [example-config.yaml](https://github.com/tulir/mautrix-telegram/blob/master/example-config.yaml). - Secret tokens should be specified using <option>environmentFile</option> + Secret tokens should be specified using {option}`environmentFile` instead of this world-readable attribute set. ''; }; |