matt1432/nixos-configs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add generated packages readme

Browse source
This commit is contained in:
matt1432 2025-01-20 15:06:16 -05:00
parent 546eda3ee2
commit 6aca512b8a
10 changed files with 71 additions and 14 deletions
apps/gen-docs
script.sh
templates
packages.md

4
apps/gen-docs/script.sh
View file

@ -20,5 +20,7 @@ substitute() {
) -t markdown --template "$2" -o "$3"
}
substitute "devShells" "$FLAKE/apps/gen-docs/templates/devShells.md" "$FLAKE/devShells/README.md"
# TODO: add configurations, homeManagerModules, lib, modules, nixFastChecks, overlays, scopedPackages
substitute "appsPackages" "$FLAKE/apps/gen-docs/templates/apps.md" "$FLAKE/apps/README.md"
substitute "devShells" "$FLAKE/apps/gen-docs/templates/devShells.md" "$FLAKE/devShells/README.md"
substitute "packages" "$FLAKE/apps/gen-docs/templates/packages.md" "$FLAKE/packages/README.md"

11
apps/gen-docs/templates/packages.md Normal file
View file

@ -0,0 +1,11 @@
# Packages
This directory contains every derivations for packages exposed by this flake.
## List of my packages found in `self.packages`
| Name | Description |
| ---- | ----------- |
$for(attrs/pairs)$
| `$it.key$` | $it.value.desc/nowrap$ | $it.value.homepage/nowrap$ |
$endfor$