diff options
| author | Emily <vcs@emily.moe> | 2023-06-22 12:21:32 +0100 |
|---|---|---|
| committer | Emily <vcs@emily.moe> | 2023-06-24 10:48:55 +0100 |
| commit | e65131e69cab1b18fb49b572b983a18720502e1b (patch) | |
| tree | 8bfb50580aad1bc01db494a138ac0855bfc518b3 /modules/documentation | |
| parent | efe314cdbabaf5cd210d9c658b4ad540437b7ee5 (diff) | |
treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]; thanks
to @pennae for writing this tool! It automatically checks that the
resulting documentation doesn't change, although my fork loosens
this a little to ignore some irrelevant whitespace and typographical
differences.
As of this commit there is no DocBook remaining in the options
documentation.
You can play along at home if you want to reproduce this commit:
$ NIX_PATH=nixpkgs=flake:nixpkgs/c1bca7fe84c646cfd4ebf3482c0e6317a0b13f22 \
nix shell nixpkgs#coreutils \
-c find . -name '*.nix' \
-exec nix run github:emilazy/nix-doc-munge/0a7190f600027bf7baf6cb7139e4d69ac2f51062 \
{} +
[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge
Diffstat (limited to 'modules/documentation')
| -rw-r--r-- | modules/documentation/default.nix | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/modules/documentation/default.nix b/modules/documentation/default.nix index d741995..7712a13 100644 --- a/modules/documentation/default.nix +++ b/modules/documentation/default.nix @@ -89,9 +89,9 @@ in documentation.enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to install documentation of packages from - <option>environment.systemPackages</option> into the generated system path. + {option}`environment.systemPackages` into the generated system path. See "Multiple-output packages" chapter in the nixpkgs manual for more info. ''; @@ -101,8 +101,8 @@ in documentation.man.enable = mkOption { type = types.bool; default = true; - description = '' - Whether to install manual pages and the <command>man</command> command. + description = lib.mdDoc '' + Whether to install manual pages and the {command}`man` command. This also includes "man" outputs. ''; }; @@ -110,8 +110,8 @@ in documentation.info.enable = mkOption { type = types.bool; default = true; - description = '' - Whether to install info pages and the <command>info</command> command. + description = lib.mdDoc '' + Whether to install info pages and the {command}`info` command. This also includes "info" outputs. ''; }; @@ -119,8 +119,8 @@ in documentation.doc.enable = mkOption { type = types.bool; default = true; - description = '' - Whether to install documentation distributed in packages' <literal>/share/doc</literal>. + description = lib.mdDoc '' + Whether to install documentation distributed in packages' `/share/doc`. Usually plain text and/or HTML. This also includes "doc" outputs. ''; |
