diff options
Diffstat (limited to 'prototypes/nixdoc/README.md')
| -rw-r--r-- | prototypes/nixdoc/README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/prototypes/nixdoc/README.md b/prototypes/nixdoc/README.md new file mode 100644 index 000000000000..0b5a0502f291 --- /dev/null +++ b/prototypes/nixdoc/README.md @@ -0,0 +1,13 @@ +# nixdoc + +Imagine rustdoc, but for nix. + + +* Parse `.nix` files +* Generate documentation, based on outputs +* Modules are already documented in nixos options + * What could this do better? Better browsability? Maybe just a + different front-end for the existing parsing mechanism? +* Parsing comments, and associating them with entries? +* Document function inputs/ outputs +* |