Getting options.json for tools like searchix

[brakenium]

Is it possible to get an options.json like it is for nixpkgs, nixos and home-manager for use with tools like searchix? If you don't know what searchix is, it is a search tool for nix options and packages that can be found here: https://searchix.ovh/. According to the searchix developer, this is necessary: https://codeberg.org/alanpearce/searchix/issues/3#issuecomment-5720786.

This is how home-manager seems to generate it: https://github.com/nix-community/home-manager/blob/master/docs/default.nix#L185-L203

[danth]

The reason we've switched to a custom solution is because we wanted to split our documentation into a separate page for each application, which was inefficient using options.json since it would write ~100 intermediate files.

It should be possible to generate an options.json from the searchix code, or via a wrapper flake if it needs to be a flake output.

We used to evaluate an empty NixOS configuration like this:

stylix/docs/default.nix

Lines 14 to 22 in a3f9fa9

	nixos = makeOptionsDoc
	(lib.nixosSystem {
	inherit (pkgs) system;
	modules = [
	inputs.home-manager.nixosModules.home-manager
	inputs.self.nixosModules.stylix
	./settings.nix
	];
	});

You can then get options.json as nixos.optionsJSON. This would need to be repeated separately for Home Manager.

[brakenium]

Thanks for the reply. It helped me to implement a wrapper flake: https://github.com/brakenium/nix-options-json-wrapper/. I'll leave it here in case anyone else stumbles upon this discussion.