TIL: how to generate NixOS module docs

Links
1
11 Likes
2

you can avoid splitting your modules into multiple files by setting check = false on evalModules, or in the newer style adding a module that sets _module.check = false. that’s how the docs system is able to cache most of the collected options documentation without needing this split; we simply skip the consistency checks since we don’t need them.

7 Likes
3

Good to know!

After splitting them out I have to admit I kinda like the separation. I’ll be sure to make an edit over the weekend though to point out that it’s not strictly necessary.

4

Thanks @pennae! Useful information and will make a great update to the blog post.

5

I couldn’t tolerate knowing I was spreading mis-information so I went ahead and added the correction :wink:

Thanks again @pennae

2 Likes
6

Before I found _module.check = false I used this trick:

lib.evalModules {
  modules = [ 
    (args: {
      inherit (import ./module.nix args) options;
    })
  ];
}

Is there any difference? What the check option is affecting?