From cc67ca420cd978160dca005d765dd33dd4878d3e Mon Sep 17 00:00:00 2001 From: DashieTM Date: Wed, 28 Aug 2024 00:07:27 +0200 Subject: [PATCH] Add docs --- .github/workflows/docs.yaml | 1 + docs/default.nix | 17 ++++++++++++++++- docs/src/SUMMARY.md | 2 ++ docs/src/dashNix.md | 1 - result | 2 +- 5 files changed, 20 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index c8c2126..ae6de9e 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -1,3 +1,4 @@ +# by https://github.com/danth/stylix/blob/master/.github/workflows/docs.yml name: Docs on: diff --git a/docs/default.nix b/docs/default.nix index cae6795..bed38b7 100644 --- a/docs/default.nix +++ b/docs/default.nix @@ -1,7 +1,22 @@ +# with friendly help by stylix: https://github.com/danth/stylix/blob/master/docs/default.nix { pkgs, build_systems, ... }: let - makeOptionsDoc = configuration: pkgs.nixosOptionsDoc { inherit (configuration) options lib; }; + makeOptionsDoc = + configuration: + pkgs.nixosOptionsDoc { + inherit (configuration) options; + + # Filter out any options not beginning with `stylix` + transformOptions = + option: + option + // { + visible = + option.visible + && (builtins.elemAt option.loc 0 == "conf" || builtins.elemAt option.loc 0 == "mods"); + }; + }; example = makeOptionsDoc (build_systems [ "example" ] ../example/.)."example"; in pkgs.stdenvNoCC.mkDerivation { diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index e69de29..bb32006 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -0,0 +1,2 @@ +[Options](dashNix.md) + diff --git a/docs/src/dashNix.md b/docs/src/dashNix.md index 9f581fd..e69de29 100755 --- a/docs/src/dashNix.md +++ b/docs/src/dashNix.md @@ -1 +0,0 @@ -pingpang diff --git a/result b/result index a4e896e..c06014d 120000 --- a/result +++ b/result @@ -1 +1 @@ -/nix/store/hpbdpm0knf560f4igq5yc6c6nvap7s65-dashNix-book \ No newline at end of file +/nix/store/0fpgnkzjnwbjykdvbk4p2h3c7isb9sz9-dashNix-book \ No newline at end of file