nix-community / nixdoc

Tool to generate documentation for Nix library functions [maintainer=@infinisil]
GNU General Public License v3.0
128 stars 14 forks source link

complete the markdown transition #40

Closed pennae closed 1 year ago

pennae commented 1 year ago

while the initial commonmark pr was good, it's not enough to fully support nixpkgs. examples were emitted as subsections (dropping them from the table of examples), types of functions weren't marked as clearly as they could've been, function location support was dropped, and the recent rnix update we did even broke parsing in a few places.

this fixes all of that. with this patch set applied we can generate a word-for-word identical nixpkgs manual without involving the docbook toolchain.

nixos-discourse commented 1 year ago

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-06-26-documentation-team-meeting-notes-58/29666/1

asymmetric commented 1 year ago

lol sorry @pennae I don't know why those two commits landed here, I've reset to your last commit.