doc: add command to continuously rebuild documentation

This commit is contained in:
ibizaman 2026-01-22 11:54:18 +01:00 committed by Pierre Penninckx
parent 6a74419271
commit aeebb4d34b
2 changed files with 17 additions and 0 deletions

View file

@ -461,6 +461,13 @@ nix flake check
nix build .#manualHtml nix build .#manualHtml
``` ```
To continuously rebuild the documentation of file change, run the following command.
To exit, you'll need to do Ctrl-C twice in a row.
```bash
nix run .#manualHtml-watch
```
### Iterative Development Approach {#iterative-development-approach} ### Iterative Development Approach {#iterative-development-approach}
1. **Start with basic functionality** - get core service working 1. **Start with basic functionality** - get core service working

View file

@ -208,6 +208,16 @@
''; '';
}); });
packages.manualHtml-watch = pkgs.writeShellApplication {
name = "manualHtml-watch";
text = ''
while sleep 1; do
find . -name "*.nix" -o -name "*.md" \
| entr -d sh -c '(nix run --offline .#update-redirects && nix build --offline .#manualHtml || :)'
done
'';
};
lib = (pkgs.callPackage ./lib { }) // { lib = (pkgs.callPackage ./lib { }) // {
test = pkgs.callPackage ./test/common.nix { }; test = pkgs.callPackage ./test/common.nix { };
contracts = pkgs.callPackage ./modules/contracts { contracts = pkgs.callPackage ./modules/contracts {