Commit Graph

8 Commits

Author SHA1 Message Date
Valentin Gagarin
b8a1ff98c1 use HTML anchors for config parameters
this avoids incorrect rendering on the man pages, since `lowdown`
neither parses the anchor syntax nor HTML.

this should rather be fixed in lowdown, as adding more anchors
would otherwise produce ever more noise and error-prone repetition.
2022-12-07 16:18:50 +01:00
Valentin Gagarin
dfa27e6b2f refactor rendering documentation of options
this makes more obvious what the code produces, and the structure of the
output easier to change
2022-12-01 06:08:08 +01:00
Patrick Jackson
b44df13701 manual: update options generation code to use default values 2022-10-20 12:05:04 -07:00
Théophane Hufschmitt
660c19eb49 manual: Add some anchor targets for the nix.conf options
For each `nix.conf` option, add an empty html node with a unique `id`
that can be used as an anchor target. Also make the name of the option
be a link to that target so that it’s easily discoverable.

We can’t rewrite the whole list as an html definition list like it’s
done for the builtins because these options also appear in a man page,
and the manpage renderer (lowdown) can’t render arbitrary html. But the
hack here allows to keep the manpage and have the links in the html
version.

Fix https://github.com/NixOS/nix/issues/5745
2022-04-05 13:50:42 +02:00
Rahul Butani
d82cf4a016
manual: fix formatting for options with "machine-specific" defaults 2022-02-15 15:44:05 -06:00
Arthur Gautier
21520297da reproducibility: hide non-reproducible settings from manual
Because the manual is generated from default values which are themselves
generated from various sources (cpuid, bios settings (kvm), number of
cores). This commit hides non-reproducible settings from the manual
output.
2021-12-01 17:25:58 +01:00
Kevin Quick
83fec38fc9
Update document generation for empty json object values. 2020-09-24 22:41:24 -07:00
Eelco Dolstra
39bc49318f jq -> nix 2020-09-16 14:58:06 +02:00