I’ve created a (perhaps silly) library just with some convenience functions for an “optional” datatype, and got my AI slave to add what it says is Nix RFC-145 docstring comments.
It’s also happily gone and generated a README.md, but for less trivial projects, I’d like to just have my docs in one place, i.e. the docstrings, and generate the README.md from that.
Alternatively I guess generating a README.html would be fine, I think github handles that.
Is there a tool to do this? I’ve found Docnix, but it doesn’t seem to be a command line tool, unless I’m missing something.
You’ll also see a test.nix in that repository (again, largely AI generated cruft) but I’d prefer to have the tests inline in optional.nix (well at least some of them), so they can act as usage documentation at the same time.
Any thoughts on how to achieve this?