Sk7Str1p3/nixos
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: move docgen comment to markdown file

Browse source
This commit is contained in:
Sk7Str1p3 2026-05-02 23:27:00 +03:00
parent 51be18d517
commit dd51a7ab58
No known key found for this signature in database
GPG key ID: 4DD995933D06D43B
3 changed files with 29 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/default.nix
View file

@ -1,26 +1,3 @@
# Documentation
/**
Docs are generated from comments in `.nix` files.
This results in kind of weird config format, but
makes it easier to track configuration changes
and add/remove docs as required.
## How docs are generated
`nixdoc` utility enables us to generate documentation
from comments in `.nix` file, like `doxygen` and `rustdoc` do.
`nixdoc` requires this flags:
- category (derived from file's path)
- description (derived from file's first line if it's commented)
most hard part is to generate SUMMARY.md.
generator uses orderKey of type "{num}|{mdPath}" and derives indentation from path's depth,
so chapters have proper order.
run `nix build .#docBuild` to build documentation.
run `nix run .#docServe` to serve documentation site
*/
{
perSystem =
{ pkgs, ... }: