Skip to content

Commit 2ad09b2

Browse files
committed
pkgs/doc: generate host-options.md
1 parent 043e59e commit 2ad09b2

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

doc/src/SUMMARY.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
- [Shared directories](./shares.md)
88
- [CPU emulation](./cpu-emulation.md)
99
- [Output options](./output-options.md)
10-
- [Options reference](./microvm-options.md)
10+
- [MicroVM options reference](./microvm-options.md)
11+
- [Host options reference](./host-options.md)
1112
- [Running a MicroVM as a package](./packages.md)
1213
- [Preparing a host for declarative MicroVMs](./host.md)
1314
- [A simple network setup](./simple-network.md)

pkgs/doc.nix

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{ nixpkgs, lib, pkgs, runCommand, mdbook, nixosOptionsDoc }:
22

33
let
4-
microvmDoc = nixosOptionsDoc {
4+
makeOptionsDoc = module: nixosOptionsDoc {
55
inherit ((lib.evalModules {
66
modules = [
7-
../nixos-modules/microvm/options.nix
7+
module
88
({ lib, ... }: {
99
# Provide `pkgs` arg to all modules
1010
config._module.args.pkgs = pkgs;
@@ -18,12 +18,17 @@ let
1818
})) options;
1919
};
2020

21+
microvmDoc = makeOptionsDoc ../nixos-modules/microvm/options.nix;
22+
23+
hostDoc = makeOptionsDoc ../nixos-modules/host/options.nix;
24+
2125
in
2226
runCommand "microvm.nix-doc" {
2327
nativeBuildInputs = [ mdbook ];
2428
} ''
2529
cp -r ${../doc} doc
2630
chmod u+w doc/src
2731
cp ${microvmDoc.optionsCommonMark} doc/src/microvm-options.md
32+
cp ${hostDoc.optionsCommonMark} doc/src/host-options.md
2833
${mdbook}/bin/mdbook build -d $out doc
2934
''

0 commit comments

Comments
 (0)