foodogsquared/nixos-config
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nixos-config.git synced 2025-04-24 12:19:12 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

modules: convert module description to RFC0072-style

Browse Source
This commit is contained in:
Gabriel Arazas 2023-07-27 11:13:39 +08:00
parent 760e1a3233
commit 3c4aef00d4
No known key found for this signature in database
GPG Key ID: ADE0C41DAB221FCC
17 changed files with 62 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
modules/home-manager/files/mutable-files.nix
View File

@ -7,7 +7,7 @@ let
options = {
url = lib.mkOption {
type = lib.types.str;
description = lib.mdDoc ''
description = ''
The URL of the file to be fetched.
'';
example = "https://github.com/foo-dogsquared/dotfiles.git";
@ -15,7 +15,7 @@ let
path = lib.mkOption {
type = lib.types.str;
description = lib.mdDoc ''
description = ''
The path of the mutable file. By default, it will be relative to the
home directory.
'';
@ -27,7 +27,7 @@ let
extractPath = lib.mkOption {
type = with lib.types; nullOr str;
description = lib.mdDoc ''
description = ''
The path within the archive to be extracted. This is only used if the
type is `archive`. If the value is `null` then it will extract the
whole archive into the directory.
@ -38,7 +38,7 @@ let
type = lib.mkOption {
type = lib.types.enum [ "git" "fetch" "archive" "gopass" "custom" ];
description = lib.mdDoc ''
description = ''
Type that configures the behavior for fetching the URL.
This accept only certain keywords.
@ -60,10 +60,10 @@ let
extraArgs = lib.mkOption {
type = with lib.types; listOf str;
description = lib.mdDoc ''
description = ''
A list of extra arguments to be included with the fetch command. Take
note of the commands used for each type as documented from
`config.home.mutableFile.<name>.type`.
{option}`config.home.mutableFile.<name>.type`.
'';
default = [ ];
example = [ "--depth" "1" ];
@ -74,7 +74,7 @@ in
{
options.home.mutableFile = lib.mkOption {
type = with lib.types; attrsOf (submodule (fileType config.home.homeDirectory));
description = lib.mdDoc ''
description = ''
An attribute set of mutable files and directories to be declaratively put
into the home directory. Take note this is not exactly pure (or
idempotent) as it will only do its fetching when the designated file is

6
modules/home-manager/programs/pop-launcher.nix
View File

@ -36,8 +36,8 @@ in
launchers.
Take note you have to install an application launcher frontend to make
use of this such as <command>onagre</command> or
<command>cosmic-launcher</command>.
use of this such as {command}`onagre` or
{command}`cosmic-launcher`.
'';
type = lib.types.bool;
default = false;
@ -47,7 +47,7 @@ in
package = lib.mkOption {
type = lib.types.package;
description = ''
The package where <command>pop-launcher</command> binary and
The package where {command}`pop-launcher` binary and
built-in plugins are expected.
'';
default = pkgs.pop-launcher;

8
modules/home-manager/services/archivebox.nix
View File

@ -19,8 +19,8 @@ let
extraArgs = lib.mkOption {
type = with lib.types; listOf str;
description = ''
Additional arguments for adding links (i.e., <literal>archivebox add
$LINK</literal>) from <option>links</option>.
Additional arguments for adding links (i.e., {command}`archivebox add
$LINK`) from {option}`links`.
'';
default = [ ];
example = lib.literalExpression ''
@ -31,8 +31,8 @@ let
startAt = lib.mkOption {
type = with lib.types; str;
description = ''
Indicates how frequent the scheduled archiving will occur.
Should be a valid string format as described from systemd.time(5).
Indicates how frequent the scheduled archiving will occur. Should be
a valid string format as described from {manpage}`systemd.time(5)`.
'';
default = "daily";
defaultText = "daily";

4
modules/home-manager/services/bleachbit.nix
View File

@ -56,7 +56,7 @@ in
description = ''
How often or when cleanup will occur. For most cases, it should be enough to clean it up once per month.
See systemd.time(7) to see the date format.
See {manpage}`systemd.time(7)` to see the date format.
'';
default = "monthly";
example = "Fri 10:00:00";
@ -65,7 +65,7 @@ in
package = lib.mkOption {
type = lib.types.package;
description = ''
The derivation containing <literal>bleachbit</literal> executable.
The derivation containing {command}`bleachbit` executable.
'';
default = pkgs.bleachbit;
};

4
modules/home-manager/services/distant.nix
View File

@ -14,14 +14,14 @@ in
enable = lib.mkEnableOption "Distant-related services";
package = lib.mkOption {
description = lib.mdDoc "The package containing the `distant` executable.";
description = "The package containing the {command}`distant` executable.";
type = lib.types.package;
default = pkgs.distant;
defaultText = "pkgs.distant";
};
settings = lib.mkOption {
description = lib.mdDoc ''
description = ''
The configuration settings to be passed to the service.
'';
types = settingsFormat.type;

18
modules/home-manager/services/gallery-dl.nix
View File

@ -16,8 +16,8 @@ let
type = with lib.types; listOf str;
default = [ ];
description = ''
A list of URLs to be downloaded to <command>gallery-dl</command>. Please
see the list of extractors with <option>--list-extractors</option>.
A list of URLs to be downloaded to {command}`gallery-dl`. Please
see the list of extractors with `--list-extractors`.
'';
example = lib.literalExpression ''
[
@ -32,10 +32,7 @@ let
description = ''
Indicates how frequent the download will occur. The given schedule
should follow the format as described from
<citerefentry>
<refentrytitle>systemd.time</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>.
{manpage}`systemd.time(5)`.
'';
default = "daily";
example = "*-*-3/4";
@ -45,8 +42,7 @@ let
type = lib.types.bool;
description = ''
Indicates whether job is persistent, starting the service despite the
timer missed. Defaults to <literal>true</literal> assuming it is used
on the desktop.
timer missed. Defaults to `true` assuming it is used on the desktop.
'';
default = true;
defaultText = "true";
@ -57,7 +53,7 @@ let
type = with lib.types; listOf str;
description = ''
Job-specific extra arguments to be passed to the
<command>gallery-dl</command>.
{command}`gallery-dl`.
'';
default = [ ];
example = lib.literalExpression ''
@ -90,7 +86,7 @@ in
package = lib.mkOption {
type = lib.types.package;
description =
"Package containing the <command>gallery-dl</command> binary.";
"Package containing the {command}`gallery-dl` binary.";
default = pkgs.gallery-dl;
defaultText = lib.literalExpression "pkgs.gallery-dl";
};
@ -125,7 +121,7 @@ in
extraArgs = lib.mkOption {
type = with lib.types; listOf str;
description =
"List of arguments to be passed to <command>gallery-dl</command>.";
"List of arguments to be passed to {command}`gallery-dl`.";
default = [ ];
example = lib.literalExpression ''
[

4
modules/home-manager/services/plover.nix
View File

@ -30,7 +30,7 @@ in
package = lib.mkOption {
type = lib.types.package;
description = -"The derivation containing the binaries for the service.";
description = "The derivation containing the binaries for the service.";
default = pkgs.plover.dev;
defaultText = "pkgs.plover.dev";
example = lib.literalExpression "pkgs.plover.stable";
@ -57,7 +57,7 @@ in
extraOptions = lib.mkOption {
type = with lib.types; listOf str;
description =
"Extra command-line arguments to pass to <literal>plover</literal>";
"Extra command-line arguments to pass to {command}`plover`";
default = [ ];
defaultText = lib.literalExpression "[]";
example = lib.literalExpression ''

19
modules/home-manager/services/yt-dlp.nix
View File

@ -13,8 +13,8 @@ let
type = with lib.types; listOf str;
default = [ ];
description = ''
A list of URLs to be downloaded to <command>yt-dlp</command>. Please
see the list of extractors with <option>--list-extractors</option>.
A list of URLs to be downloaded to {command}`yt-dlp`. Please
see the list of extractors with `--list-extractors`.
'';
example = lib.literalExpression ''
[
@ -29,10 +29,7 @@ let
description = ''
Indicates how frequent the download will occur. The given schedule
should follow the format as described from
<citerefentry>
<refentrytitle>systemd.time</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>.
{manpage}`systemd.time(5)`.
'';
default = "daily";
example = "*-*-3/4";
@ -42,8 +39,8 @@ let
type = lib.types.bool;
description = ''
Indicates whether the service will start if timer has missed.
Defaults to <literal>true</literal> since this module mainly assumes
it is used on the desktop.
Defaults to `true` since this module mainly assumes it is used on the
desktop.
'';
default = true;
defaultText = "true";
@ -53,7 +50,7 @@ let
extraArgs = lib.mkOption {
type = with lib.types; listOf str;
description =
"Job-specific extra arguments to be passed to the <command>yt-dlp</command>.";
"Job-specific extra arguments to be passed to the {command}`yt-dlp`";
default = [ ];
example = lib.literalExpression ''
[
@ -71,7 +68,7 @@ in
package = lib.mkOption {
type = lib.types.package;
description =
"The derivation that contains <command>yt-dlp</command> binary.";
"The derivation that contains {command}`yt-dlp` binary.";
default = pkgs.yt-dlp;
defaultText = lib.literalExpression "pkgs.yt-dlp";
example = lib.literalExpression
@ -96,7 +93,7 @@ in
extraArgs = lib.mkOption {
type = with lib.types; listOf str;
description =
"List of arguments to be passed to <command>yt-dlp</command>.";
"List of arguments to be passed to {command}`yt-dlp`.";
default = [ "--download-archive '${cfg.archivePath}/download-list" ];
example = lib.literalExpression ''
[

4
modules/nixos/programs/cardboard-wm.nix
View File

@ -17,8 +17,8 @@ in
default = pkgs.cardboard;
defaultText = lib.literalExpression "pkgs.cardboard";
description = ''
The derivation containing the <command>cardboard</command>
and <command>cutter</command> binary.
The derivation containing the {command}`cardboard` and
{command}`cutter` binary.
'';
};

2
modules/nixos/programs/kiwmi.nix
View File

@ -9,7 +9,7 @@ in
options.programs.kiwmi = {
enable = lib.mkEnableOption "Kiwmi, a fully programmable Wayland compositor";
package = lib.mkOption {
description = "The package containing the <literal>kiwmi</literal> and <literal>kiwmic</literal>.";
description = "The package containing the {command}`kiwmi` and {command}`kiwmic`.";
type = lib.types.package;
default = pkgs.kiwmi;
};

8
modules/nixos/programs/pop-launcher.nix
View File

@ -35,8 +35,8 @@ in
launchers.
However, you have to install an application launcher frontend to make
use of this such as <command>onagre</command> or
<command>cosmic-launcher</command>.
use of this such as {command}`onagre` or
{command}`cosmic-launcher`.
'';
type = lib.types.bool;
default = false;
@ -46,8 +46,8 @@ in
package = lib.mkOption {
type = lib.types.package;
description = ''
The package where <command>pop-launcher</command> binary and
built-in plugins are expected.
The package where {command}`pop-launcher` binary and built-in plugins
are expected.
'';
default = pkgs.pop-launcher;
};

2
modules/nixos/programs/wezterm.nix
View File

@ -14,7 +14,7 @@ in
package = lib.mkOption {
type = lib.types.package;
default = pkgs.wezterm;
description = "Package containing <command>wezterm</command> binary.";
description = "Package containing {command}`wezterm` binary.";
};
};

8
modules/nixos/services/archivebox.nix
View File

@ -19,8 +19,8 @@ let
extraArgs = lib.mkOption {
type = with lib.types; listOf str;
description = ''
Additional arguments for adding links (i.e., <literal>archivebox add
$LINK</literal>) from <option>links</option>.
Additional arguments for adding links (i.e., {command}`archivebox add
$LINK`) from {option}`links`.
'';
default = [ ];
example = lib.literalExpression ''
@ -31,8 +31,8 @@ let
startAt = lib.mkOption {
type = with lib.types; str;
description = ''
Indicates how frequent the scheduled archiving will occur.
Should be a valid string format as described from systemd.time(5).
Indicates how frequent the scheduled archiving will occur. Should be
a valid string format as described from {manpage}`systemd.time(5)`.
'';
default = "weekly";
defaultText = "weekly";

15
modules/nixos/services/gallery-dl.nix
View File

@ -15,8 +15,8 @@ let
type = with lib.types; listOf str;
default = [ ];
description = ''
A list of URLs to be downloaded to <command>gallery-dl</command>. Please
see the list of extractors with <option>--list-extractors</option>.
A list of URLs to be downloaded to {command}`gallery-dl`. Please
see the list of extractors with `--list-extractors`.
'';
example = lib.literalExpression ''
[
@ -31,10 +31,7 @@ let
description = ''
Indicates how frequent the download will occur. The given schedule
should follow the format as described from
<citerefentry>
<refentrytitle>systemd.time</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>.
{manpage}`systemd.time(5)`.
'';
default = "daily";
example = "*-*-3/4";
@ -55,7 +52,7 @@ let
type = with lib.types; listOf str;
description = ''
Job-specific extra arguments to be passed to the
<command>gallery-dl</command>.
{command}`gallery-dl`.
'';
default = [ ];
example = lib.literalExpression ''
@ -88,7 +85,7 @@ in
package = lib.mkOption {
type = lib.types.package;
description =
"Package containing the <command>gallery-dl</command> binary.";
"Package containing the {command}`gallery-dl` binary.";
default = pkgs.gallery-dl;
defaultText = lib.literalExpression "pkgs.gallery-dl";
};
@ -121,7 +118,7 @@ in
extraArgs = lib.mkOption {
type = with lib.types; listOf str;
description =
"List of arguments to be passed to <command>gallery-dl</command>.";
"List of arguments to be passed to {command}`gallery-dl`.";
default = [ ];
example = lib.literalExpression ''
[

4
modules/nixos/services/wezterm-mux-server.nix
View File

@ -8,7 +8,7 @@ in
enable = lib.mkEnableOption "Wezterm mux server";
package = lib.mkOption {
type = lib.types.package;
description = lib.mdDoc ''
description = ''
The package containing the {command}`wezterm-mux-server` binary.
'';
default = pkgs.wezterm;
@ -16,7 +16,7 @@ in
};
configFile = lib.mkOption {
type = with lib.types; nullOr path;
description = lib.mdDoc ''
description = ''
The path to the configuration file. For more information, you can see
[its section for setting up multiplexing](https://wezfurlong.org/wezterm/multiplexing.html).
'';

15
modules/nixos/services/yt-dlp.nix
View File

@ -13,8 +13,8 @@ let
type = with lib.types; listOf str;
default = [ ];
description = ''
A list of URLs to be downloaded to <command>yt-dlp</command>. Please
see the list of extractors with <option>--list-extractors</option>.
A list of URLs to be downloaded to {command}`yt-dlp`. Please
see the list of extractors with `--list-extractors`.
'';
example = lib.literalExpression ''
[
@ -29,10 +29,7 @@ let
description = ''
Indicates how frequent the download will occur. The given schedule
should follow the format as described from
<citerefentry>
<refentrytitle>systemd.time</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>.
{manpage}`systemd.time(5)`.
'';
default = "daily";
example = "*-*-3/4";
@ -52,7 +49,7 @@ let
extraArgs = lib.mkOption {
type = with lib.types; listOf str;
description =
"Job-specific extra arguments to be passed to the <command>yt-dlp</command>.";
"Job-specific extra arguments to be passed to the {command}`yt-dlp`.";
default = [ ];
example = lib.literalExpression ''
[
@ -70,7 +67,7 @@ in
package = lib.mkOption {
type = lib.types.package;
description =
"The derivation that contains <command>yt-dlp</command> binary.";
"The derivation that contains {command}`yt-dlp` binary.";
default = pkgs.yt-dlp;
defaultText = lib.literalExpression "pkgs.yt-dlp";
example = lib.literalExpression
@ -88,7 +85,7 @@ in
extraArgs = lib.mkOption {
type = with lib.types; listOf str;
description =
"List of arguments to be passed to <command>yt-dlp</command>.";
"List of arguments to be passed to {command}`yt-dlp`.";
default = [ "--download-archive videos" ];
example = lib.literalExpression ''
[

2
modules/nixos/workflows/a-happy-gnome/default.nix
View File

@ -26,7 +26,7 @@ in
type = with lib.types; listOf package;
description = ''
A list of GNOME Shell extensions to be included. Take note the package
contain <literal>passthru.extensionUuid</literal> to be used for
contain `passthru.extensionUuid` to be used for
enabling the extensions.
'';
default = with pkgs.gnomeExtensions; [