Mirrors/home-manager
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

treewide: convert custom enable docs to Markdown

Browse source 
`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
Show stats Download patch file Download diff file Expand all files Collapse all files

10
modules/misc/debug.nix
View file

@ -4,12 +4,12 @@ with lib;
{
options.home = {
enableDebugInfo = mkEnableOption "" // {
description = ''
Some Nix-packages provide debug symbols for
<command>gdb</command> in the <literal>debug</literal>-output.
enableDebugInfo = mkEnableOption (lib.mdDoc "") // {
description = lib.mdDoc ''
Some Nix packages provide debug symbols for
{command}`gdb` in the `debug` output.
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.
'';
};

10
modules/misc/vte.nix
View file

@ -6,15 +6,19 @@ with lib;
meta.maintainers = [ maintainers.rycee ];
options.programs = let
description = ''
description = lib.mdDoc ''
Whether to enable integration with terminals using the VTE
library. This will let the terminal track the current working
directory.
'';
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 [

3
modules/programs/atuin.nix
View file

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

24
modules/programs/git.nix
View file

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

8
modules/programs/java.nix
View file

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

8
modules/services/autorandr.nix
View file

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

14
modules/services/blueman-applet.nix
View file

@ -5,16 +5,16 @@ with lib;
{
options = {
services.blueman-applet = {
enable = mkEnableOption "" // {
description = ''
enable = mkEnableOption (lib.mdDoc "") // {
description = lib.mdDoc ''
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
configuration using
<programlisting language="nix">
services.blueman.enable = true;
</programlisting>
```nix
services.blueman.enable = true;
```
'';
};
};

10
modules/services/random-background.nix
View file

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

8
modules/services/udiskie.nix
View file

@ -25,12 +25,12 @@ in {
options = {
services.udiskie = {
enable = mkEnableOption "udiskie mount daemon" // {
description = ''
enable = mkEnableOption (lib.mdDoc "") // {
description = lib.mdDoc ''
Whether to enable the udiskie mount daemon.
</para><para>
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
the Udisk2 DBus service is not found.
'';

4
modules/targets/generic-linux.nix
View file

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