3
0
Fork 0
forked from mirrors/nixpkgs
Commit graph

80 commits

Author SHA1 Message Date
Matthew Bauer 17ec7f3a16 nixpkgs/manual: document fetcher functions
Fixes #32439.
2019-01-26 22:48:47 -05:00
Jörg Thalheim eac6797380
prefer-fetch-remote: an overlay to fetch on remote builders
This is useful when running tools like NixOps or nix-review
on workstations where the upload to the builder is significantly
slower then downloading the source on the builder itself.
2019-01-18 14:41:10 +00:00
Vincent Ambo 0c99dac497 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.
2019-01-04 11:28:27 +01:00
John Ericson b71389aefb
Merge pull request #47430 from roberth/nixpkgs-extend
pkgs.extend for adding overlays
2018-10-23 20:21:48 -04:00
Ingo Blechschmidt 00b555ef88 nixpkgs docs: Fix tiny typo (#48477) 2018-10-23 14:41:15 +00:00
Robert Hensing a5c4642ddf doc: Add link from overrides to overlays 2018-10-19 12:25:17 +02:00
Robert Hensing 3c2ae189c2 doc: Improve overrides and overlays documentation 2018-10-18 14:01:06 +02:00
Robert Hensing 9b7654f6ff nixpkgs docs: Point to pkgs.extend, pkgs.appendOverlays and improve override section 2018-10-18 10:48:43 +02:00
Graham Christensen 0eb3b93e1a
nixpkgs docs: document recursivelyUpdate 2018-10-12 16:54:34 -04:00
Graham Christensen c100a456b1
nixpkgs docs: document recursivelyUpdateUntil 2018-10-12 16:54:34 -04:00
Graham Christensen 77140a9075
nixpkgs docs: document zipAttrs 2018-10-12 16:54:34 -04:00
Graham Christensen 655a5fa8bf
nixpkgs docs: document zipAttrsWith 2018-10-12 16:54:34 -04:00
Graham Christensen 4edb31882c
nixpkgs docs: Clarify zipAttrsWithNames's docs 2018-10-12 16:54:33 -04:00
Graham Christensen 3b3bde463b
nixpkgs docs: document zipAttrsWithNames 2018-10-12 16:06:12 -04:00
Graham Christensen e0c6981d19
nixpkgs docs: document optionalAttrs 2018-10-12 16:06:12 -04:00
Graham Christensen c547c3fe82
nixpkgs docs: document toDerivation 2018-10-12 16:06:12 -04:00
Graham Christensen f85a4ba9c3
nixpkgs docs: document isDerivation 2018-10-12 16:06:11 -04:00
Graham Christensen ef05e1057b
nixpkgs docs: document genAttrs 2018-10-12 16:06:11 -04:00
Graham Christensen d664b8f5e3
nixpkgs docs: document mapAttrsRecursiveCond 2018-10-12 16:06:11 -04:00
Graham Christensen e7549b96ad
nixpkgs docs: finish up mapAttrsRecursive 2018-10-12 16:06:11 -04:00
Graham Christensen 5daee73ce4
Generate links to function definitions
Hydra passes the full revision in to the input, which we pass through.

If we don't get this ,we try to get it from other sources, or default to
master which should have the definition in a close-ish location.

All published docs should have theURL resolve properly, only local
hackers will have the link break.
2018-10-05 11:20:46 -04:00
Graham Christensen f835f77e02
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-05 10:06:08 -04:00
Graham Christensen c07ba7c856
nixpkgs docs: Reformat 2018-10-02 15:59:59 -04:00
Graham Christensen c3125498fd
shell functions: rewrite as xml 2018-10-02 14:16:27 -04:00
Graham Christensen 507a63c885
nixpkgs docs: move shell section to its own file 2018-10-02 14:13:42 -04:00
Graham Christensen 8bf342ffb8
nixpkgs docs: move dockertool to its own file 2018-10-02 14:13:12 -04:00
Graham Christensen 0856d5c4ad
nixpkgs docs: move fhs-environments to its own file 2018-10-02 14:08:36 -04:00
Graham Christensen 3ac79c89b7
nixpkgs docs: move debug to its own file 2018-10-02 14:07:06 -04:00
Graham Christensen 9ae39b3553
nixpkgs docs: move generators to its own file 2018-10-02 14:03:59 -04:00
Graham Christensen f200a322c4
nixpkgs docs: move overrides to its own file 2018-10-02 13:52:21 -04:00