diff options
| author | Mx Kookie <kookie@spacekookie.de> | 2020-11-03 12:38:16 +0100 |
|---|---|---|
| committer | Mx Kookie <kookie@spacekookie.de> | 2020-12-21 05:19:28 +0100 |
| commit | 8be6dc679e97053da8f173333578ed626466d3de (patch) | |
| tree | 4bd38eb3eb3dc93c9f2e3474f9d10af5a0a41d1f /prototypes/nixdoc/README.md | |
| parent | eb1b781fabde92081d9e8ba5ede17cbfbf4f7edf (diff) | |
prototype: init directory with nixdoc outline
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 +* |