Prepare documentation for custom modules

Not activated yet as it seems unnecessary overhead for now.
This commit is contained in:
Daniel Siepmann 2024-06-24 17:31:35 +02:00
parent 7baf8d5f6e
commit 83bce30e6e
Signed by: Daniel Siepmann
GPG key ID: 33D6629915560EF4
4 changed files with 27 additions and 0 deletions

View file

@ -69,6 +69,8 @@
info.enable = false;
man.enable = true;
nixos.enable = true;
# Turn on in order to generate documentation also from my own custom modules.
# nixos.includeAllModules = true;
};
programs = {

View file

@ -18,6 +18,10 @@ in {
certFolder = lib.mkOption {
type = lib.types.path;
default = "${config.custom.web-development.rootPath}/own/mkcert/";
description = ''
Defines the folder within the filesystem which should contain all the generated certificates,
as well as the root certificate.
'';
};
};
};

View file

@ -17,6 +17,10 @@ in {
options = {
relativeDocumentRoot = lib.mkOption {
type = str;
description = ''
Define the relative document root to use for serving the project.
The custom.web-development.rootPath will be prepanded.
'';
};
};
});

View file

@ -17,20 +17,37 @@ in {
options = {
relativeDocumentRoot = lib.mkOption {
type = str;
description = ''
Define the relative document root to use for serving the project.
The custom.web-development.rootPath will be prepanded.
'';
};
databaseName = lib.mkOption {
type = str;
description = ''
Define the name of the database to use for the project.
This will be created if missing and will be exposed as environment variable to the project.
'';
};
phpPackage = lib.mkOption {
type = package;
description = ''
The PHP package to use.
'';
};
phpExtraConfig = lib.mkOption {
type = str;
default = "";
description = ''
Provide any extra configuration to add to the php.ini.
'';
};
phpEnv = lib.mkOption {
type = attrsOf str;
default = {};
description = ''
Provide any extra environment variables to be exposed to PHP-FPM.
'';
};
};
});