mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-06-12 04:35:41 +03:00
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.
This commit is contained in:
parent
eab0c3258f
commit
0c99dac497
3 changed files with 38 additions and 2 deletions
|
@ -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>
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue