pederbs/config
pederbs
/
config
2
1
Fork 0
Code Issues Pull Requests Releases Activity

http/docs: remote with lib, remove md

This commit is contained in:
Peder Bergebakken Sundt 2024-10-04 03:17:33 +02:00
parent d1d06e192f
commit 307b1d26f3
1 changed files with 19 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
profiles/http/docs/default.nix
View File

@ -44,40 +44,39 @@ let
in
{
options = with lib; {
services.docs-to-host.enable = mkEnableOption (lib.mdDoc "docs-to-host");
services.docs-to-host.pagefind = {
enable = mkEnableOption (lib.mdDoc "pagefind default on index of docs");
package = mkPackageOptionMD pkgs.unstable "pagefind" { };
};
services.docs-to-host.docs = mkOption {
type = types.listOf (types.submodule {
options = {
dirname = mkOption {
type = types.str;
example = "linux-doc";
description = lib.mdDoc "The relative dirname at which the documentation will be linked";
services.docs-to-host.enable = lib.mkEnableOption "docs-to-host";
services.docs-to-host.pagefind = {
enable = lib.mkEnableOption "pagefind default on index of docs";
package = lib.mkPackageOption pkgs "pagefind" { };
};
basename = mkOption {
type = types.str;
services.docs-to-host.docs = lib.mkOption {
type = lib.types.listOf (lib.types.submodule {
options = {
dirname = lib.mkOption {
type = lib.types.str;
example = "linux-doc";
description = "The relative dirname at which the documentation will be linked";
};
basename = lib.mkOption {
type = lib.types.str;
example = "foobar.html";
default = "";
description = lib.mdDoc "The basename to which the documentation entry will be linked. Not needed if index.html exists.";
description = "The basename to which the documentation entry will be linked. Not needed if index.html exists";
};
path = mkOption {
type = types.path;
path = lib.mkOption {
type = lib.types.path;
example = lib.literalExpression "pkgs.fetchzip {...}";
description = lib.mdDoc "The static html documentation to host";
description = "The static html documentation to host";
};
desc = mkOption {
type = types.str;
#description = "A short decription about the hosted documentation in markdown.";
description = "A short decription about the hosted documentation.";
desc = lib.mkOption {
type = lib.types.str;
description = "A short decription about the hosted documentation";
};
};
});
default = [ ];
#description = lib.mdDoc ''TODO'';
#description = ''TODO'';
};
};