diff options
| author | pennae <github@quasiparticle.net> | 2022-08-29 23:34:22 +0200 |
|---|---|---|
| committer | pennae <github@quasiparticle.net> | 2022-08-31 16:32:53 +0200 |
| commit | c915b915b5e466a0b0b2af2906cd4d2380b8a1de (patch) | |
| tree | 9e153e37bef5bb5e4214dfcaa3843a96de7cf4d4 /nixos/modules/misc/documentation.nix | |
| parent | 1013069f52123135cc1d96b2b7d77606a22d3b33 (diff) | |
nixos/*: md-convert options with unordered lists
mostly no rendering changes. some lists (like simplelist) don't have an exact translation to markdown, so we use a comma-separated list of literals instead.
Diffstat (limited to 'nixos/modules/misc/documentation.nix')
| -rw-r--r-- | nixos/modules/misc/documentation.nix | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/nixos/modules/misc/documentation.nix b/nixos/modules/misc/documentation.nix index 251a361a580c9..5dcdc8f96c449 100644 --- a/nixos/modules/misc/documentation.nix +++ b/nixos/modules/misc/documentation.nix @@ -226,15 +226,14 @@ in nixos.enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to install NixOS's own documentation. - <itemizedlist> - <listitem><para>This includes man pages like - <citerefentry><refentrytitle>configuration.nix</refentrytitle><manvolnum>5</manvolnum></citerefentry> if <option>documentation.man.enable</option> is - set.</para></listitem> - <listitem><para>This includes the HTML manual and the <command>nixos-help</command> command if - <option>documentation.doc.enable</option> is set.</para></listitem> - </itemizedlist> + + - This includes man pages like + {manpage}`configuration.nix(5)` if {option}`documentation.man.enable` is + set. + - This includes the HTML manual and the {command}`nixos-help` command if + {option}`documentation.doc.enable` is set. ''; }; |