From c031abcd9e805b511c842bd88fa18455211881ff Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Wed, 8 Oct 2025 15:42:18 +0200 Subject: [PATCH] docs: move option-search into own package --- checks/flake-module.nix | 2 +- docs/.gitignore | 2 +- docs/mkdocs.yml | 2 +- docs/nix/default.nix | 8 ++++---- docs/nix/flake-module.nix | 5 +---- docs/site/index.md | 2 ++ pkgs/flake-module.nix | 11 ++++++----- .../options => pkgs/option-search}/flake-module.nix | 4 ++-- 8 files changed, 18 insertions(+), 18 deletions(-) rename {docs/nix/options => pkgs/option-search}/flake-module.nix (98%) diff --git a/checks/flake-module.nix b/checks/flake-module.nix index 703fc6093..c4af4f3d1 100644 --- a/checks/flake-module.nix +++ b/checks/flake-module.nix @@ -120,7 +120,7 @@ in ) (self.darwinConfigurations or { }) // lib.mapAttrs' (n: lib.nameValuePair "package-${n}") ( if system == "aarch64-darwin" then - lib.filterAttrs (n: _: n != "docs" && n != "deploy-docs" && n != "docs-options") packagesToBuild + lib.filterAttrs (n: _: n != "docs" && n != "deploy-docs" && n != "option-search") packagesToBuild else packagesToBuild ) diff --git a/docs/.gitignore b/docs/.gitignore index 3f1c155ae..2cb144263 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,6 +1,6 @@ /site/reference /site/services/official /site/static -/site/options +/site/option-search /site/openapi.json !/site/static/extra.css diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 89516f105..a2b0be602 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -180,7 +180,7 @@ nav: - services/official/zerotier.md - services/community.md - - Search Clan Options: "/options" + - Search Clan Options: "/option-search" docs_dir: site site_dir: out diff --git a/docs/nix/default.nix b/docs/nix/default.nix index 510ffb7e3..47fa49026 100644 --- a/docs/nix/default.nix +++ b/docs/nix/default.nix @@ -5,7 +5,7 @@ clan-lib-openapi, roboto, fira-code, - docs-options, + option-search, ... }: let @@ -51,9 +51,9 @@ pkgs.stdenv.mkDerivation { chmod -R +w ./site echo "Generated API documentation in './site/reference/' " - rm -rf ./site/options - cp -r ${docs-options} ./site/options - chmod -R +w ./site/options + rm -rf ./site/option-search + cp -r ${option-search} ./site/option-search + chmod -R +w ./site/option-search # Link to fonts ln -snf ${roboto}/share/fonts/truetype/Roboto-Regular.ttf ./site/static/ diff --git a/docs/nix/flake-module.nix b/docs/nix/flake-module.nix index 6e14fea47..2543d19c3 100644 --- a/docs/nix/flake-module.nix +++ b/docs/nix/flake-module.nix @@ -1,8 +1,5 @@ { inputs, self, ... }: { - imports = [ - ./options/flake-module.nix - ]; perSystem = { config, @@ -96,7 +93,7 @@ docs = pkgs.python3.pkgs.callPackage ./default.nix { inherit (self'.packages) clan-cli-docs - docs-options + option-search inventory-api-docs clan-lib-openapi ; diff --git a/docs/site/index.md b/docs/site/index.md index 5ae8b870a..23200e478 100644 --- a/docs/site/index.md +++ b/docs/site/index.md @@ -70,6 +70,8 @@ hide: .clamp-toggle:checked ~ .clamp-more::after { content: "Read less"; } +trivial change +
diff --git a/pkgs/flake-module.nix b/pkgs/flake-module.nix index bcdacba07..bdf0911e9 100644 --- a/pkgs/flake-module.nix +++ b/pkgs/flake-module.nix @@ -2,12 +2,13 @@ { imports = [ - ./clan-cli/flake-module.nix - ./clan-vm-manager/flake-module.nix - ./installer/flake-module.nix - ./icon-update/flake-module.nix - ./clan-core-flake/flake-module.nix ./clan-app/flake-module.nix + ./clan-cli/flake-module.nix + ./clan-core-flake/flake-module.nix + ./clan-vm-manager/flake-module.nix + ./icon-update/flake-module.nix + ./installer/flake-module.nix + ./option-search/flake-module.nix ./testing/flake-module.nix ]; diff --git a/docs/nix/options/flake-module.nix b/pkgs/option-search/flake-module.nix similarity index 98% rename from docs/nix/options/flake-module.nix rename to pkgs/option-search/flake-module.nix index d78a971ab..3f43474b6 100644 --- a/docs/nix/options/flake-module.nix +++ b/pkgs/option-search/flake-module.nix @@ -118,7 +118,7 @@ _file = "docs flake-module"; imports = [ { _module.args = { inherit clanLib; }; } - (import ../../../lib/modules/inventoryClass/roles-interface.nix { + (import ../../lib/modules/inventoryClass/roles-interface.nix { nestedSettingsOption = mkOption { type = types.raw; description = '' @@ -201,7 +201,7 @@ # }; packages = { - docs-options = + option-search = if privateInputs ? nuschtos then privateInputs.nuschtos.packages.${pkgs.stdenv.hostPlatform.system}.mkMultiSearch { inherit baseHref;