Skip to content

docs/mdbook: support visible = "shallow" #2932

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
merged 1 commit into from
Jan 29, 2025
Merged

docs/mdbook: support visible = "shallow" #2932

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
27 changes: 20 additions & 7 deletions docs/mdbook/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,31 @@ let
removeWhitespace = builtins.replaceStrings [ " " ] [ "" ];

getSubOptions =
opts: path: lib.optionalAttrs (isVisible opts) (removeUnwanted (opts.type.getSubOptions path));
opts: path:
lib.optionalAttrs (isDeeplyVisible opts) (removeUnwanted (opts.type.getSubOptions path));

isVisible =
opts:
isVisible = isVisibleWith true;
isDeeplyVisible = isVisibleWith false;

isVisibleWith =
shallow: opts:
let
test =
opt:
let
internal = opt.internal or false;
visible = opt.visible or true;
visible' = if visible == "shallow" then shallow else visible;
in
visible' && !internal;
in
if lib.isOption opts then
opts.visible or true && !(opts.internal or false)
test opts
else if opts.isOption then
opts.index.options.visible or true && !(opts.index.options.internal or false)
test opts.index.options
else
let
filterFunc = lib.filterAttrs (_: v: if lib.isAttrs v then isVisible v else true);

filterFunc = lib.filterAttrs (_: v: if lib.isAttrs v then isVisibleWith shallow v else true);
hasEmptyIndex = (filterFunc opts.index.options) == { };
hasEmptyComponents = (filterFunc opts.components) == { };
in
Expand Down
Loading