diff options
| author | Vincent Ambo <mail@tazj.in> | 2018-12-30 01:10:19 +0100 |
|---|---|---|
| committer | Frederik Rietdijk <freddyrietdijk@fridh.nl> | 2019-01-04 11:28:27 +0100 |
| commit | 0c99dac49735d3a7c20d231c4d7b1dc057bc81df (patch) | |
| tree | a45072f55fc1c27189c95285d17512c3632a7bb3 /doc/functions/library.xml | |
| parent | eab0c3258ff90ee1023b2488e2237b315d8d486b (diff) | |
| download | nixpkgs-0c99dac49735d3a7c20d231c4d7b1dc057bc81df.tar nixpkgs-0c99dac49735d3a7c20d231c4d7b1dc057bc81df.tar.gz nixpkgs-0c99dac49735d3a7c20d231c4d7b1dc057bc81df.tar.bz2 nixpkgs-0c99dac49735d3a7c20d231c4d7b1dc057bc81df.tar.lz nixpkgs-0c99dac49735d3a7c20d231c4d7b1dc057bc81df.tar.xz nixpkgs-0c99dac49735d3a7c20d231c4d7b1dc057bc81df.tar.zst nixpkgs-0c99dac49735d3a7c20d231c4d7b1dc057bc81df.zip | |
doc: Add automatic generation of library function documentation
Modifies the build process of the manual to invoke nixdoc automatically to generate XML files with function documentation. Currently documentation is present for five of the files in `lib/`. To add another file to the generated docs, both `doc/functions/library.xml` and `doc/lib-function-docs.nix` must be updated.
Diffstat (limited to 'doc/functions/library.xml')
| -rw-r--r-- | doc/functions/library.xml | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/functions/library.xml b/doc/functions/library.xml index 901423c52a1..b01de3c6e41 100644 --- a/doc/functions/library.xml +++ b/doc/functions/library.xml @@ -12,4 +12,13 @@ <xi:include href="./library/asserts.xml" /> <xi:include href="./library/attrsets.xml" /> + + <!-- These docs are generated via nixdoc. To add another generated + library function file to this list, the file + `lib-function-docs.nix` must also be updated. --> + <xi:include href="./library/generated/strings.xml" /> + <xi:include href="./library/generated/trivial.xml" /> + <xi:include href="./library/generated/lists.xml" /> + <xi:include href="./library/generated/debug.xml" /> + <xi:include href="./library/generated/options.xml" /> </section> |