Commit Graph

17 Commits

Author SHA1 Message Date
Philip Taron
b5dc82844f
nixpkgs-manual: init 2024-07-26 13:46:12 -07:00
Philip Taron
4252286f21
doc: extract nixpkgs-manual into its own package
Also, use `finalAttrs` style and pass through all the helper derivations.
2024-07-26 13:44:04 -07:00
Philip Taron
87b8931d74
doc: make ./doc-support/lib-function-docs.nix callPackage style
Move `libsets` over to it, since it's the only user.

Format with `nixfmt` since we're changing it so dramatically.
2024-07-26 13:44:04 -07:00
Silvan Mosberger
f01573b6ee doc: Prevent evaluation warnings
Problem: `nix-build doc` gives a bunch of warnings because it inspects
`lib` to figure out where all the symbols are.

Solution: Move the step of figuring out where the symbols are to
a Nix evaluation inside a derivation instead.
2024-07-18 23:33:29 +02:00
Johannes Kirschbauer
48a2178434 adds block_args for autogenerated ids from trustworthy sources 2024-01-29 22:29:39 +01:00
Robert Hensing
aa1beb0ab5 doc: Render lib.fixedPoints 2023-07-08 18:46:08 +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
pennae
b521f451a3 doc-support: don't expose locationsXml
nothing except function docs uses this, so we need not expose it. we'll
be reworking this entire section of the build anyway, with the target of
breaking up doc-support as it is now.
2023-07-01 20:27:29 +02:00
Silvan Mosberger
8496683ec9 lib: Allow doc rendering for lib/<name>/default.nix 2022-12-23 21:10:43 +01:00
Naïm Favier
5782c3d802
doc/lib-functions: print libset name before description 2022-12-22 11:31:11 +01:00
Naïm Favier
ce952286ca
doc/lib-functions: preserve libsets order 2022-12-22 11:31:11 +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
figsoda
403e25e3e3 doc: fix typos 2022-12-17 18:21:48 -05: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
Robert Hensing
4a025692d1 lib.sources: Generate docs 2021-05-29 16:03:54 +02:00
Graham Christensen
cd6bf8aa00
docs: use a single nix-build for all the generate function docs 2019-07-04 09:07:47 -04:00