Skip to content

refactor(docgen): 1 drv #267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BirdeeHub merged 1 commit into from
Feb 2, 2026
Merged

refactor(docgen): 1 drv #267

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 58 additions & 37 deletions docs/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
config,
lib,
wlib,
pkgs,
Expand All @@ -17,27 +18,50 @@ let
moduleStartsOpen ? null,
}:
name: module:
pkgs.writeText "${name}-${prefix}-docs" (
(if title != null then "# ${title}\n\n" else "# `${prefix}${name}`\n\n")
+ wrapperModuleMD (
wlib.evalModule [
module
{
_module.check = false;
inherit pkgs;
${if package != null then "package" else null} = package;
}
]
// {
inherit includeCore;
${if descriptionStartsOpen != null then "descriptionStartsOpen" else null} = descriptionStartsOpen;
${if descriptionIncluded != null then "descriptionIncluded" else null} = descriptionIncluded;
${if moduleStartsOpen != null then "moduleStartsOpen" else null} = moduleStartsOpen;
(if title != null then "# ${title}\n\n" else "# `${prefix}${name}`\n\n")
+ wrapperModuleMD (
wlib.evalModule [
module
{
_module.check = false;
inherit pkgs;
${if package != null then "package" else null} = package;
}
)
]
// {
inherit includeCore;
${if descriptionStartsOpen != null then "descriptionStartsOpen" else null} = descriptionStartsOpen;
${if descriptionIncluded != null then "descriptionIncluded" else null} = descriptionIncluded;
${if moduleStartsOpen != null then "moduleStartsOpen" else null} = moduleStartsOpen;
}
);

module_docs = builtins.mapAttrs (buildModuleDocs {
in
{
imports = [
wlib.wrapperModules.mdbook
./redirects.nix
];
mainBook = "nix-wrapper-modules";
outputs = [
"out"
"generated"
];
drv.unsafeDiscardReferences.generated = true;
drv.preBuild = ''
mkdir -p "$generated/wrapper_docs"
jq -r '.wrapper_docs | to_entries[] | @base64' "$NIX_ATTRS_JSON_FILE" | while read -r entry; do
# decode base64 to get JSON safely
decoded=$(echo "$entry" | base64 --decode)
echo "$(echo "$decoded" | jq -r '.value')" > "$generated/wrapper_docs/$(echo "$decoded" | jq -r '.key').md"
done
mkdir -p "$generated/module_docs"
jq -r '.module_docs | to_entries[] | @base64' "$NIX_ATTRS_JSON_FILE" | while read -r entry; do
decoded="$(echo "$entry" | base64 --decode)"
echo "$(echo "$decoded" | jq -r '.value')" > "$generated/module_docs/$(echo "$decoded" | jq -r '.key').md"
done
'';
drv.module_docs = builtins.mapAttrs (buildModuleDocs {
prefix = "wlib.modules.";
package = pkgs.hello;
includeCore = false;
Expand All @@ -49,16 +73,13 @@ let
_: _: _:
true;
}) wlib.modules;
wrapper_docs = builtins.mapAttrs (buildModuleDocs {
drv.wrapper_docs = builtins.mapAttrs (buildModuleDocs {
prefix = "wlib.wrapperModules.";
}) wlib.wrapperModules;
in
{
imports = [
wlib.wrapperModules.mdbook
./redirects.nix
];
mainBook = "nix-wrapper-modules";
drv.core_docs = buildModuleDocs {
package = pkgs.hello;
title = "Core (builtin) Options set";
} "core" wlib.core;
books.nix-wrapper-modules = {
book = {
book = {
Expand Down Expand Up @@ -130,40 +151,40 @@ in
name = "Core Options Set";
data = "numbered";
path = "lib/core.md";
src = buildModuleDocs {
package = pkgs.hello;
title = "Core (builtin) Options set";
} "core" wlib.core;
build = ''
jq -r '.core_docs' "$NIX_ATTRS_JSON_FILE" > "$generated/core.md"
'';
src = "${placeholder "generated"}/core.md";
}
{
name = "`wlib.modules.default`";
data = "numbered";
path = "modules/default.md";
src = module_docs.default;
src = "${placeholder "generated"}/module_docs/default.md";
}
{
name = "Helper Modules";
data = "numbered";
path = "md/helper-modules.md";
src = ./md/helper-modules.md;
subchapters = lib.mapAttrsToList (n: v: {
subchapters = lib.mapAttrsToList (n: _: {
name = n;
data = "numbered";
path = "modules/${n}.md";
src = v;
}) (removeAttrs module_docs [ "default" ]);
src = "${placeholder "generated"}/module_docs/${n}.md";
}) (removeAttrs config.drv.module_docs [ "default" ]);
}
{
name = "Wrapper Modules";
data = "numbered";
path = "md/wrapper-modules.md";
src = ./md/wrapper-modules.md;
subchapters = lib.mapAttrsToList (n: v: {
subchapters = lib.mapAttrsToList (n: _: {
name = n;
data = "numbered";
path = "wrapperModules/${n}.md";
src = v;
}) wrapper_docs;
src = "${placeholder "generated"}/wrapper_docs/${n}.md";
}) config.drv.wrapper_docs;
}
];
};
Expand Down