-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Description
We would like to generate documentation for these nix tools.
Some helpful links:
- RFC for some standardized syntax to document nix stuff: https://github.com/NixOS/rfcs/blob/master/rfcs/0145-doc-strings.md
- Example of generating documentation from modules (flake-parts): https://mlabs-haskell.github.io/cardano.nix/reference/module-options/globals/ and https://github.com/mlabs-haskell/cardano.nix/blob/master/docs/default.nix which was adapted from https://github.com/nix-community/ethereum.nix
- Example of having a nice webpage for the generated documentation: https://github.com/mlabs-haskell/plutus-ledger-api-typescript/blob/a97beb22678e7d2f73e0affbf84fd5231890cae2/hercules-ci.nix#L19-L22 and https://github.com/mlabs-haskell/plutus-ledger-api-typescript/blob/a97beb22678e7d2f73e0affbf84fd5231890cae2/flake.nix#L42-L50
Metadata
Metadata
Assignees
Labels
No labels