It looks like most of the current documentation for the Nix projects is written as separate, parallel manuals, eg:
This is per the guidelines laid out in https://github.com/NixOS/rfcs/blob/71f76fab15d2d6c3b86ae2814c6d7adef8f59d75/rfcs/0072-commonmark-docs.md
But I do note that some files in nixpkgs have docblocks that look like they could well be extracted and rendered into documentation similar to how Doxygen or Sphinx works:
This could be as sophisticated as something like rnix-parser, or as naive as some regular expressions. Has there been any effort made to bridge this gap, and build a doc-extractor for a Nix codebase, that could render out the documented functions to markdown or rST pages, for example for inclusion in a Sphinx-based manual?
I’m interested in this topic in general, but also specifically with respect to Nix code related to packaging ROS (Robot Operating System), for example: https://github.com/clearpathrobotics/nix-ros-base/blob/76f97d373d1c61d48df146dbd42df8202a9ff1fe/lib/build-colcon-package.nix
I don’t think I have the resources to maintain a fully separate manual for this codebase, but it sure would be helpful to be able to at least extract properly formatted comments.