1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-09-28 09:17:28 +02:00

treewide: convert custom enable docs to Markdown

`nix-doc-munge` can't tell what's going on with this pattern, so I
just handled them all manually.
This commit is contained in:
Emily 2023-07-01 08:48:09 +01:00
parent 3222c99a91
commit 9e4a73c25e
10 changed files with 52 additions and 47 deletions

View file

@ -4,12 +4,12 @@ with lib;
{ {
options.home = { options.home = {
enableDebugInfo = mkEnableOption "" // { enableDebugInfo = mkEnableOption (lib.mdDoc "") // {
description = '' description = lib.mdDoc ''
Some Nix-packages provide debug symbols for Some Nix packages provide debug symbols for
<command>gdb</command> in the <literal>debug</literal>-output. {command}`gdb` in the `debug` output.
This option ensures that those are automatically fetched from This option ensures that those are automatically fetched from
the binary cache if available and <command>gdb</command> is the binary cache if available and {command}`gdb` is
configured to find those symbols. configured to find those symbols.
''; '';
}; };

View file

@ -6,15 +6,19 @@ with lib;
meta.maintainers = [ maintainers.rycee ]; meta.maintainers = [ maintainers.rycee ];
options.programs = let options.programs = let
description = '' description = lib.mdDoc ''
Whether to enable integration with terminals using the VTE Whether to enable integration with terminals using the VTE
library. This will let the terminal track the current working library. This will let the terminal track the current working
directory. directory.
''; '';
in { in {
bash.enableVteIntegration = mkEnableOption "" // { inherit description; }; bash.enableVteIntegration = mkEnableOption (lib.mdDoc "") // {
inherit description;
};
zsh.enableVteIntegration = mkEnableOption "" // { inherit description; }; zsh.enableVteIntegration = mkEnableOption (lib.mdDoc "") // {
inherit description;
};
}; };
config = mkMerge [ config = mkMerge [

View file

@ -30,7 +30,8 @@ in {
''; '';
}; };
enableZshIntegration = mkEnableOption "Zsh integration" // { enableZshIntegration = mkOption {
type = types.bool;
default = true; default = true;
description = '' description = ''
Whether to enable Atuin's Zsh integration. Whether to enable Atuin's Zsh integration.

View file

@ -265,10 +265,10 @@ in {
}; };
difftastic = { difftastic = {
enable = mkEnableOption "" // { enable = mkEnableOption (lib.mdDoc "") // {
description = '' description = lib.mdDoc ''
Enable the <command>difftastic</command> syntax highlighter. Enable the {command}`difftastic` syntax highlighter.
See <link xlink:href="https://github.com/Wilfred/difftastic" />. See <https://github.com/Wilfred/difftastic>.
''; '';
}; };
@ -303,10 +303,10 @@ in {
}; };
delta = { delta = {
enable = mkEnableOption "" // { enable = mkEnableOption (lib.mdDoc "") // {
description = '' description = lib.mdDoc ''
Whether to enable the <command>delta</command> syntax highlighter. Whether to enable the {command}`delta` syntax highlighter.
See <link xlink:href="https://github.com/dandavison/delta" />. See <https://github.com/dandavison/delta>.
''; '';
}; };
@ -335,10 +335,10 @@ in {
}; };
diff-so-fancy = { diff-so-fancy = {
enable = mkEnableOption "" // { enable = mkEnableOption (lib.mdDoc "") // {
description = '' description = lib.mdDoc ''
Enable the <command>diff-so-fancy</command> diff colorizer. Enable the {command}`diff-so-fancy` diff colorizer.
See <link xlink:href="https://github.com/so-fancy/diff-so-fancy" />. See <https://github.com/so-fancy/diff-so-fancy>.
''; '';
}; };

View file

@ -14,10 +14,10 @@ in {
options = { options = {
programs.java = { programs.java = {
enable = mkEnableOption "" // { enable = mkEnableOption (lib.mdDoc "") // {
description = '' description = lib.mdDoc ''
Install the Java development kit and set the <envar>JAVA_HOME</envar> Install the Java development kit and set the
variable. {env}`JAVA_HOME` variable.
''; '';
}; };

View file

@ -10,11 +10,11 @@ in {
options = { options = {
services.autorandr = { services.autorandr = {
enable = mkEnableOption "" // { enable = mkEnableOption (lib.mdDoc "") // {
description = '' description = lib.mdDoc ''
Whether to enable the Autorandr systemd service. Whether to enable the Autorandr systemd service.
This module is complementary to <code>programs.autorandr</code> which handles the This module is complementary to {option}`programs.autorandr`
configuration (profiles). which handles the configuration (profiles).
''; '';
}; };

View file

@ -5,16 +5,16 @@ with lib;
{ {
options = { options = {
services.blueman-applet = { services.blueman-applet = {
enable = mkEnableOption "" // { enable = mkEnableOption (lib.mdDoc "") // {
description = '' description = lib.mdDoc ''
Whether to enable the Blueman applet. Whether to enable the Blueman applet.
</para><para>
Note, for the applet to work, the 'blueman' service should Note that for the applet to work, the `blueman` service should
be enabled system-wide. You can enable it in the system be enabled system-wide. You can enable it in the system
configuration using configuration using
<programlisting language="nix"> ```nix
services.blueman.enable = true; services.blueman.enable = true;
</programlisting> ```
''; '';
}; };
}; };

View file

@ -15,14 +15,14 @@ in {
options = { options = {
services.random-background = { services.random-background = {
enable = mkEnableOption "" // { enable = mkEnableOption (lib.mdDoc "") // {
description = '' description = lib.mdDoc ''
Whether to enable random desktop background. Whether to enable random desktop background.
</para><para>
Note, if you are using NixOS and have set up a custom Note, if you are using NixOS and have set up a custom
desktop manager session for Home Manager, then the session desktop manager session for Home Manager, then the session
configuration must have the <option>bgSupport</option> configuration must have the `bgSupport`
option set to <literal>true</literal> or the background option set to `true` or the background
image set by this module may be overwritten. image set by this module may be overwritten.
''; '';
}; };

View file

@ -25,12 +25,12 @@ in {
options = { options = {
services.udiskie = { services.udiskie = {
enable = mkEnableOption "udiskie mount daemon" // { enable = mkEnableOption (lib.mdDoc "") // {
description = '' description = lib.mdDoc ''
Whether to enable the udiskie mount daemon. Whether to enable the udiskie mount daemon.
</para><para>
Note, if you use NixOS then you must add Note, if you use NixOS then you must add
<code>services.udisks2.enable = true</code> `services.udisks2.enable = true`
to your system configuration. Otherwise mounting will fail because to your system configuration. Otherwise mounting will fail because
the Udisk2 DBus service is not found. the Udisk2 DBus service is not found.
''; '';

View file

@ -20,8 +20,8 @@ in {
]; ];
options.targets.genericLinux = { options.targets.genericLinux = {
enable = mkEnableOption "" // { enable = mkEnableOption (lib.mdDoc "") // {
description = '' description = lib.mdDoc ''
Whether to enable settings that make Home Manager work better on Whether to enable settings that make Home Manager work better on
GNU/Linux distributions other than NixOS. GNU/Linux distributions other than NixOS.
''; '';