JakeHillion/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
3698ce1755
nixpkgs/doc/functions/library.xml

29 lines
929 B
XML
Raw Normal View History

nixpkgs: Start documenting library functions in XML Covers assert functions and about half of the attrsets functions. Some internal consistency around IDs could be improved.
2018-10-02 21:06:33 +01:00
<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>
doc: re-format
2019-09-18 21:12:54 +01:00
Nixpkgs provides a standard library at <varname>pkgs.lib</varname>, or through <code>import &lt;nixpkgs/lib&gt;</code>.
nixpkgs: Start documenting library functions in XML Covers assert functions and about half of the attrsets functions. Some internal consistency around IDs could be improved.
2018-10-02 21:06:33 +01:00
</para>
<xi:include href="./library/asserts.xml" />
<xi:include href="./library/attrsets.xml" />
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.
2018-12-30 00:10:19 +00:00
doc: format the documentation (#57102)
2019-03-09 05:07:11 +00:00
<!-- These docs are generated via nixdoc. To add another generated
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.
2018-12-30 00:10:19 +00:00
library function file to this list, the file
`lib-function-docs.nix` must also be updated. -->
doc: format the documentation (#57102)
2019-03-09 05:07:11 +00: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.
2018-12-30 00:10:19 +00:00
<xi:include href="./library/generated/strings.xml" />
doc: format the documentation (#57102)
2019-03-09 05:07:11 +00: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.
2018-12-30 00:10:19 +00:00
<xi:include href="./library/generated/trivial.xml" />
doc: format the documentation (#57102)
2019-03-09 05:07:11 +00: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.
2018-12-30 00:10:19 +00:00
<xi:include href="./library/generated/lists.xml" />
doc: format the documentation (#57102)
2019-03-09 05:07:11 +00: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.
2018-12-30 00:10:19 +00:00
<xi:include href="./library/generated/debug.xml" />
doc: format the documentation (#57102)
2019-03-09 05:07:11 +00: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.
2018-12-30 00:10:19 +00:00
<xi:include href="./library/generated/options.xml" />
nixpkgs: Start documenting library functions in XML Covers assert functions and about half of the attrsets functions. Some internal consistency around IDs could be improved.
2018-10-02 21:06:33 +01:00
</section>
Reference in New Issue Copy Permalink