mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-12-01 10:00:56 +00:00
0c99dac497
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.
25 lines
927 B
XML
25 lines
927 B
XML
<section xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xml:id="sec-functions-library">
|
|
<title>Nixpkgs Library Functions</title>
|
|
|
|
<para>
|
|
Nixpkgs provides a standard library at <varname>pkgs.lib</varname>, or
|
|
through <code>import <nixpkgs/lib></code>.
|
|
</para>
|
|
|
|
<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>
|