From f5d594f79022f4468fae9d04418cb607890a9347 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 21 Feb 2024 18:03:13 +0000 Subject: [PATCH] Auto generate docs/reference/options.md --- docs/reference/options.md | 197 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 191 insertions(+), 6 deletions(-) diff --git a/docs/reference/options.md b/docs/reference/options.md index f2ad91364..3c69b571c 100644 --- a/docs/reference/options.md +++ b/docs/reference/options.md @@ -19,10 +19,195 @@ list of package +## aws-vault.enable + +Whether to enable aws-vault integration. + + + +*Type:* +boolean + + + +*Default:* +` false ` + + + +*Example:* +` true ` + +*Declared by:* + - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix) + + + +## aws-vault.package + +The aws-vault package to use. + + + +*Type:* +package + + + +*Default:* +` pkgs.aws-vault ` + +*Declared by:* + - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix) + + + +## aws-vault.awscliWrapper + +Attribute set of packages including awscli2 + +*Type:* +submodule + + + +*Default:* +` pkgs ` + +*Declared by:* + - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix) + + + +## aws-vault.awscliWrapper.enable + +Whether to enable Wraps awscli2 binary as `aws-vault exec -- aws `. +. + + + +*Type:* +boolean + + + +*Default:* +` false ` + + + +*Example:* +` true ` + +*Declared by:* + - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix) + + + +## aws-vault.awscliWrapper.package + +The awscli2 package to use. + + + +*Type:* +package + + + +*Default:* +` pkgs.awscli2 ` + +*Declared by:* + - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix) + + + +## aws-vault.profile + + + +The profile name passed to ` aws-vault exec `. + + + +*Type:* +string + +*Declared by:* + - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix) + + + +## aws-vault.terraformWrapper + +Attribute set of packages including terraform + + + +*Type:* +submodule + + + +*Default:* +` pkgs ` + +*Declared by:* + - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix) + + + +## aws-vault.terraformWrapper.enable + +Whether to enable Wraps terraform binary as `aws-vault exec -- terraform `. +. + + + +*Type:* +boolean + + + +*Default:* +` false ` + + + +*Example:* +` true ` + +*Declared by:* + - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix) + + + +## aws-vault.terraformWrapper.package + +The terraform package to use. + + + +*Type:* +package + + + +*Default:* +` pkgs.terraform ` + +*Declared by:* + - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix) + + + ## certificates List of domains to generate certificates for. + + *Type:* list of string @@ -2081,8 +2266,6 @@ null or strings concatenated with “\\n” Options appended to the PHP configuration file `php.ini`. - - *Type:* strings concatenated with “\\n” @@ -2342,6 +2525,8 @@ You need not specify the options `error_log` or `daemonize` here, since they are already set. + + *Type:* attribute set of (string or signed integer or boolean) @@ -4663,8 +4848,6 @@ boolean ## pre-commit.settings.alejandra.exclude - - Files or directories to exclude from formatting. @@ -4856,6 +5039,8 @@ boolean ## pre-commit.settings.clippy.denyWarnings + + Fail when warnings are present @@ -6828,8 +7013,6 @@ one of “stderr”, “errfmt”, “json” ## pre-commit.settings.statix.ignore - - Globs of file patterns to skip. @@ -7064,6 +7247,8 @@ boolean ## pre-commit.settings.typos.locale + + Which language to use for spell checking.