aboutsummaryrefslogtreecommitdiff
path: root/lix-doc/src
AgeCommit message (Collapse)Author
2024-07-10lix-doc: update dependencies and refactorLunaphied
This updates the version of rnix used and refactors the code generally to be more precise and capable in it's identification of both lambdas and determining which documentation comments are attached. Change-Id: Ib0dddabd71f772c95077f9d7654023b37a7a1fd2
2024-05-15lix-doc: don't chomp bold headings offFireFly
There are a few places in nixpkgs lib where `**Foo**:` is used as a heading instead of the usual markdown `# Foo` ones. I think this is intentional with how it gets rendered in the manual, e.g. [`lib.lists.sortOn`][1]. [1]: https://nixos.org/manual/nixpkgs/stable/#function-library-lib.lists.sortOn `nix-doc` prints this as ``` *Laws**: ```nix sortOn f == sort (p: q: f p < f q) ``` ``` chomping off the first asterisk as part of `cleanup_single_line` that's meant to deal with `/** \n * \n * \n */` style doc comments. This also means the usage in lix ends up funny-looking with a trailing asterisk as if there's a footnote to pay attention to (which is how I first noticed it, heh) The fix: When cleaning up a single line and removing a prefix comment character, ensure it's followed by whitespace (or the last character of the line). Upstream-PR: https://github.com/lf-/nix-doc/pull/26 Change-Id: If2870c53a632f6bbbcca98a4bfbd72f5bef37879
2024-04-08nix-doc -> lix-doc, make self-contained in package.nixJade Lovelace
package.nix previously needed this callPackage'd externally, which didn't make a lot of sense to us since this is an internal dependency. Thus we changed it to make it more self contained. Change-Id: I4935bc0bc80e1a132bc9b1519e917791da95037c