nixdoc
nixdoc copied to clipboard
nix-community
Tool to generate documentation for Nix library functions [maintainer=@infinisil]
Output is CommonMark with some syntax extensions: * DD lists * heading anchors
(**Warning: This thread may contain bikeshedding!**) ------------- It would be nice to have support for some markup format in documentation strings. The easiest one that everybody knows is Markdown. It's...
Hi! It recently came to my attention that this project is [used in the nixpkgs manual](https://github.com/NixOS/nixpkgs/blob/master/doc/doc-support/lib-function-docs.nix). We've recently accepted a community proposal to change the manual from [DocBook to CommonMark](https://github.com/NixOS/rfcs/blob/master/rfcs/0072-commonmark-docs.md)...
It's related to #5 Some languages make the distinction between comments and documentation block by extending the comment syntax. For example in Rust, `//` is a comment and `///` is...
**Don't merge yet.** I'm currently exploring a library called "rowan" in rnix, which supplies a builder for ASTs making the code prettier, but also makes comments completely separate tokens. Sadly...
Documentation should be near its definition. We have some important functions, the fetch* family, that are defined in their own files. Instead of adding those files with their single comments...
Currently sections (i.e. the "groups" of functions, `strings`, `lists` etc.) generated by `nixdoc` don't have any descriptions other than what the user specifies on the CLI. Some files (for example...
In @grahamc's manually written doc comments, multiple (named) examples are supported. It would be great to be able to specify examples in the comments, too. Currently these syntaxes are recognised:...
The current comment "parser" does not preserve whitespace correctly, especially leading whitespace in example listings. This is low-priority until comment formats etc. are decided.
Return values may need further explanation, e.g. function. Proposal: Support a `Returns:` section with a free-form string.
Metadata
Owner
Metadata
Tool to generate documentation for Nix library functions [maintainer=@infinisil]