Silvan Mosberger
54a93d0525
Merge pull request #312407 from hsjobeki/doc/lib-generators
...
doc: init lib.generators reference documentation
2024-06-26 22:09:05 +02:00
Silvan Mosberger
be6f553b7d
doc: Remove unneeded functions/library dir
...
All its files were removed years ago!
2024-06-15 16:35:12 +02:00
Johannes Kirschbauer
8ee634f5a6
doc: init lib.generators reference documentation
2024-05-21 21:54:47 +02:00
Janne Heß
fcc95ff817
treewide: Fix all Nix ASTs in all markdown files
...
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
2024-03-28 09:28:12 +01:00
Philip Taron
86ae7a6243
Remove top level with lib; in docs ( #293829 )
2024-03-06 22:35:43 +01:00
Silvan Mosberger
228df50ff9
lib.fileset: Move introduction section above the functions
...
Previously the introductory section and the function listings were in
different places. But now nixdoc supports having them together
with https://github.com/nix-community/nixdoc/pull/70 !
2023-11-19 15:00:57 +01:00
Silvan Mosberger
2556605a35
lib.fileset: Remove "somewhat limited" from the docs
...
It's not very limited anymore :)
2023-11-08 23:32:53 +01:00
Silvan Mosberger
c5ae093f13
lib.fileset: Various updates relating to union/unions
...
Also some minor formatting improvements
2023-09-21 00:21:01 +02:00
Silvan Mosberger
465e05c0c5
lib.fileset.toSource: init
2023-09-01 15:46:04 +02:00
pennae
be4d19ff1a
doc: render nixpkgs manual with nrd
...
also updates nixdoc to 2.3.0. the nixdoc update is not a separate commit
because that would leave the manual build broken for one commit,
potentially breaking bisects and rebases.
2023-07-01 20:59:29 +02:00
Andrew
1b6f640687
doc: correct typos and spelling ( #237098 )
2023-06-11 02:15:43 +02:00
Naïm Favier
d11832fd96
doc,nixos/doc: unescape apostrophes
...
Leftovers from the CommonMark conversion.
2022-12-27 17:13:47 +01:00
Naïm Favier
8906aa28e4
doc/lib-functions: remove warnings
...
Building the nixpkgs manual currently triggers a bunch of deprecation
warnings, because every attribute in `lib` is evaluated to see if it's
an attrset to generate locations for.
Instead, share the lib subsets to include in the documentation
between `lib-function-docs` and `lib-function-locations` so they can
coordinate.
Also generate the list of sections instead of duplicating it in
`library.xml`.
2022-12-22 11:31:08 +01:00
Ryan Mulligan
ac1ae0a58e
doc: auto-generate asserts and attrset library docs
...
If all the docs are auto-generated, it should be easier to convert
them to Commonmark.
Co-Authored-By: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-Authored-By: Silvan Mosberger <contact@infinisil.com>
2022-12-08 22:58:22 +01:00
Silvan Mosberger
9bfc4bbd63
lib: Automatically generate lib.filesytem docs
2022-10-26 15:10:47 +02:00
Théophile Wallez
3f25903151
nixos/nixpkgs/doc: fix typo in the signature of attrsets.zipAttrs
2022-03-13 13:59:51 +01:00
Jan Tojnar
64d7a3266b
doc: Fix xref in functions description
...
This was accidentally broken by 3c78ad2561
2021-11-14 22:30:07 +01:00
Doron Behar
d74960e8db
Merge pull request #105494 from alunduil/missing-operator-mapAttr-doc
2021-08-07 17:14:41 +00:00
Robert Hensing
4c4c00e9f1
Merge pull request #124875 from hercules-ci/lib-sources
...
lib.sources: docs, tests, refactoring
2021-06-28 14:02:37 +02:00
rnhmjoj
ad5deab11a
doc/functions/generators: fix code block
...
Small fixup of 606bf6d
2021-06-22 14:03:36 +02:00
Ryan Mulligan
606bf6dc17
doc/functions/generators: convert to CommonMark
2021-06-11 06:06:42 -07:00
Ryan Mulligan
c682532fce
doc/functions/prefer-remote-fetch: convert to CommonMark
2021-06-07 20:18:39 -07:00
Ryan Mulligan
e560790890
Merge pull request #125957 from ryantm/md-debug
...
doc/functions/debug: convert to CommonMark
2021-06-07 19:57:22 -07:00
Ryan Mulligan
fbfdc8fc0b
doc/functions/debug: convert to CommonMark
2021-06-07 19:56:38 -07:00
Ryan Mulligan
2f92034d30
Merge pull request #125838 from jtojnar/strict-commonmark
...
doc: Parse as CommonMark
2021-06-07 06:02:29 -07:00
Jan Tojnar
3c78ad2561
doc: Use markdown syntax for xrefs
...
Syntax is taken from MyST:
https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
2021-06-07 06:34:59 +02:00
Antoine Martin
26ac257e4f
doc: nix-gitignore to CommonMark
...
Closes #125670
2021-06-05 18:20:26 +02:00
Robert Hensing
4a025692d1
lib.sources: Generate docs
2021-05-29 16:03:54 +02:00
Erlend Pedersen
3452a739d1
nixpkgs-manual: lib.attrsets.mapAttrsToList returns a list ( #122179 )
2021-05-08 13:55:11 +02:00
Florian Engel
22cb630a66
Fix type description for attrByPath
...
The output type was missing
2021-03-14 10:27:26 +01:00
Robert Hensing
7d551ead60
doc: Format
2021-03-04 18:10:57 +01:00
Doron Behar
c858d0f63a
Merge pull request #105492 from alunduil/assertOneOf-typo
2021-02-07 18:44:50 +02:00
Jacek Galowicz
123045a570
lib/attrsets: add cartesianProductOfSets function
2021-01-28 23:08:59 +01:00
Alex Brandt
11b6ded912
nixos/nixpkgs/doc: add missing operator to attrsets.mapAttrs example.
...
It looks like this operator was missing (just a dropped +) unless I'm
missing something unexpected about the Nix syntax I've forgotten.
2020-11-30 21:19:50 +00:00
Alex Brandt
195fe01e8b
nixos/nixpkgs/docs: fix typo in assertOneOf example
...
This example was confusing at first because the element the message
indicated wasn't in the list of possible values was but the possible
values didn't match up either. This ensures the example is consistent
with the logic being presented.
2020-11-30 20:56:33 +00:00
Robert Hensing
e38a01db5d
Merge pull request #68491 from roberth/fix-dontRecurseIntoAttrs
...
Fix dontRecurseIntoAttrs + add to lib + doc
2020-03-01 11:05:34 +01:00
ivann
9605addd32
fix catAttrs documentation signature
2020-01-12 00:04:18 +01:00
Frederik Rietdijk
2b9713c281
doc: move fhs and mkShell under builders/special
...
In my opinion Functions should only contain pure functions. These are
both meant to provide derivations so I put them under Builders. Don't
know exactly *where* to put them so "special" it is...
2019-10-21 11:39:46 +02:00
Frederik Rietdijk
24b1ef5133
doc: move overrides into separate chapter
2019-10-21 11:19:46 +02:00
Frederik Rietdijk
9d54ea9b2d
doc: move image builders into new images chapter
2019-10-21 10:57:56 +02:00
Frederik Rietdijk
16d733bbe5
doc: move fetchers and trivial builders under builders
2019-10-20 13:35:04 +02:00
Jan Tojnar
83c2ad80ca
doc: re-format
2019-09-18 22:12:54 +02:00
worldofpeace
cd518845e2
doc/stdenv: document meson variables
2019-09-17 21:30:09 -04:00
Robert Hensing
a96f37db10
Document attrsets.recurseIntoAttrs
2019-09-11 14:55:23 +02:00
Katharina Fey
e72ec381b2
ociTools: fixing outdated documentation
2019-09-09 08:05:33 +01:00
Katharina Fey
18f7f19ce2
ociTools: init
2019-09-04 22:46:42 +00:00
Graham Christensen
abf82a18fb
doc/functions/dockertools.xml: clarify that "Commands" means shell commands
...
Co-Authored-By: Jon <jonringer@users.noreply.github.com>
2019-08-15 09:47:05 -04:00
Graham Christensen
8adaae2df2
dockertools.buildLayeredImage: default layer count up to 100
2019-08-12 19:59:40 -04:00
Graham Christensen
2e6a16f2bd
dockerTools: document extraCommands
2019-08-12 19:56:57 -04:00
Graham Christensen
dc336293a1
doc: fix after snaptools merge
2019-07-10 08:02:14 -07:00
