nix-community / nixdoc

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

feat: Support manual overrides of documentation bodies #15

Closed tazjin closed 6 years ago

tazjin commented 6 years ago

Adds support for including manually written documentation from files at a pre-determined path.

All elements of the documentation after the section and title are inserted as <xi:fallback> attributes, which lets users write a file at nixpkgs/doc/functions/library/overrides/<functionPath>.xml to manually document a function of required.

There should be very few cases where this comes up in practice.

This fixes #14