add mkFlakeDoc to pkgs-lib to build options doc #240
Conversation
| ``` | ||
|
|
||
|
|
||
| ## channels.<name>.config |
There was a problem hiding this comment.
The <name> part doesn't seem to get rendered right. I don't know enough about markdown to know why that is. Maybe I need to escape characters?
| ``` | ||
|
|
||
|
|
||
| ## home |
There was a problem hiding this comment.
This is mentioned in evalArgs.nix but home doesn't get a hosts because homeConfigurations are auto-generated from nixos.hosts
| The flake to create the devos outputs for | ||
| *_Type_*: |
There was a problem hiding this comment.
There should be a space between these two lines.
| @@ -15,6 +15,7 @@ lib.genAttrs utils.lib.defaultSystems (system: | |||
|
|
|||
| tests = callLibs ./tests; | |||
| shell = callLibs ./shell; | |||
| mkFlakeDoc = callLibs ./mkFlakeDoc.nix; | |||
There was a problem hiding this comment.
To build doc:
nix build .#lib.pkgs-lib.x86_64-linux.mkFlakeDoc
If we make lib a flake, this should go in it's packages output.
This doesn't build yet in the branch, you have to add the old evalArgs to get the flake to actually evaluate.
|
This might need updating after release cleanup. |
|
I went ahead and added a rebased (but not optimized) version of this into the It works as intended with Hence, I'm going to close this so we can continue over there. |
Just built the doc - requires a bit of fen-angling - because current api-next flake doesn't work since mkflake hasn't been updated. We can use this PR to go over option/type descriptions and include any doc improvements.
Overall I think the descriptions can use some work, we need to clearly communicate what each API argument is for and the reasoning behind the option. I think a fresh set of eyes could help with that, especially someone who wasn't part of all the discussion for the API design.
This document should be able to quickly answer questions like "What happened to extern?" or "How should I import modules from other flakes?".
I should not attempt to cover everything - thats what the other doc sections are for - just a simple and straightforward summary of what each argument provides and is used for.
This replaces parts of #232.