aboutsummaryrefslogtreecommitdiff
path: root/prototypes/nixdoc/README.md
blob: 0b5a0502f291366561df02ba6dc27b9e947d5ba8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
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
*