My personal project and infrastructure archive
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
nomicon/prototypes/nixdoc
Katharina Fey 91a0a6bff7 libkookie: add .projectile files to existing projects 3 years ago
..
src prototype: init directory with nixdoc outline 3 years ago
.projectile libkookie: add .projectile files to existing projects 3 years ago
Cargo.toml prototype: init directory with nixdoc outline 3 years ago
README.md prototype: init directory with nixdoc outline 3 years ago

README.md

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