mirror of
https://github.com/divnix/digga.git
synced 2024-12-23 08:02:21 +03:00
65 lines
1.9 KiB
Nix
65 lines
1.9 KiB
Nix
{ system ? builtins.currentSystem
|
|
, inputs ? (import ../.).inputs
|
|
}:
|
|
let
|
|
|
|
inherit (inputs) digga;
|
|
pkgs = inputs.nixpkgs.legacyPackages.${system};
|
|
|
|
docOptions = digga.lib.mkFlake.options { self = { }; inputs = { }; };
|
|
evaledOptions = (pkgs.lib.evalModules { modules = [ docOptions ]; }).options;
|
|
|
|
mkDocPartMd = part: title: intro:
|
|
pkgs.writeText "api-reference-${part}.md" ''
|
|
# ${title}
|
|
${intro}
|
|
|
|
${(
|
|
pkgs.nixosOptionsDoc { options = evaledOptions.${part}; }
|
|
).optionsMDDoc}
|
|
'';
|
|
|
|
in
|
|
{
|
|
|
|
mkApiReferenceTopLevel = pkgs.writeText "api-reference.md" ''
|
|
# Top Level API
|
|
`digga`'s top level API. API Containers are documented in their respective sub-chapter:
|
|
|
|
- [Channels](./api-reference-channels.md)
|
|
- [Home](./api-reference-home.md)
|
|
- [Devshell](./api-reference-devshell.md)
|
|
- [NixOS](./api-reference-nixos.md)
|
|
|
|
${( pkgs.nixosOptionsDoc {
|
|
options = {
|
|
inherit (evaledOptions)
|
|
channelsConfig
|
|
self
|
|
inputs
|
|
outputsBuilder
|
|
supportedSystems
|
|
;
|
|
};
|
|
}).optionsMDDoc}
|
|
'';
|
|
|
|
mkApiReferenceChannels = mkDocPartMd "channels" "Channels API Container" ''
|
|
Configure your channels that you can use throughout your configurations.
|
|
|
|
> #### ⚠ Gotcha ⚠
|
|
> Devshell & (non-host-specific) Home-Manager `pkgs` instances are rendered off the
|
|
> `nixos.hostDefaults.channelName` (default) channel.
|
|
'';
|
|
mkApiReferenceDevshell = mkDocPartMd "devshell" "Devshell API Container" ''
|
|
Configure your devshell module collections of your environment.
|
|
'';
|
|
mkApiReferenceHome = mkDocPartMd "home" "Home-Manager API Container" ''
|
|
Configure your home manager modules, profiles & suites.
|
|
'';
|
|
mkApiReferenceNixos = mkDocPartMd "nixos" "NixOS API Container" ''
|
|
Configure your nixos modules, profiles & suites.
|
|
'';
|
|
|
|
}
|