Naïm Favier
330b1e08b8
nixos/lib/make-options-doc: implement literalDocBook
2021-10-03 17:59:44 +02:00
Pacman99
d12aba5406
nixosOptionsDoc: add markdown formatting
2021-04-13 10:10:40 -07:00
rnhmjoj
3f8a3246f4
nixos/lib/make-options-doc: remove loaOf subs
...
Remove the substitution for the <name?> placeholder used by loaOf,
now that the type has been deprecated.
2020-09-02 00:42:51 +02:00
Maximilian Bosch
6d19c04416
nixos/manual: improve error message for invalid values in `relatedPackages'
...
As reported in NixOS discourse[1], tracking down invalid values in
`relatedPackages'[2] (i.e. list-items that don't exist in `pkgs`) is
fairly hard as the message "Invalid package attribute path `foobar'"
is quite unhelpful and the trace doesn't point to the source of the
problem either.
This patch improves the error message by mentioning that the issue is an
invalid `relatedPackages`-declaration in $optionName.
[1] https://discourse.nixos.org/t/invalid-package-attribute-path-nextcloud19/8403/9
[2] https://nixos.org/nixpkgs/manual/#sec-functions-library-options
2020-08-03 16:37:59 +02:00
Jan Tojnar
cab6b019b1
Revert "make-options-doc: fix string context issues"
...
This reverts commit 3c15d578d4https://github.com/NixOS/nixpkgs/issues/83863
2020-04-02 00:53:54 +02:00
Eelco Dolstra
4052f9b849
Compress optionsJSON using brotli
2020-03-24 16:42:04 +01:00
Dima
3c15d578d4
make-options-doc: fix string context issues
...
When using `documentation.nixos.includeAllModules = true;` with external
modules, the string context might contain dependencies to derivations
and so `toFile` refuses to evaluate;
```
error: in 'toFile': the file 'options.xml' cannot refer to derivation outputs, at
[...]/nixpkgs/nixos/lib/make-options-doc/default.nix:89:16
```
This is not an issue when using `writeText` (instead of manually
stripping the context).
2019-11-23 15:40:45 +01:00
volth
08f68313a4
treewide: remove redundant rec
2019-08-28 11:07:32 +00:00
Domen Kožar
dcd50c0ea0
pkgs.lib -> lib
2019-08-12 11:46:53 +02:00
Domen Kožar
6cf861c617
make-options-doc: add asciidoc variant
2019-08-10 20:11:04 +02:00
Domen Kožar
3a93fcfd1e
make-options-doc: expose Nix set
2019-08-10 14:24:11 +02:00
Domen Kožar
5cfd034af0
Extract NixOS options documentation generation to a function
...
Motivation is to support other repositories containing nixos
modules that would like to generate options documentation:
- nix-darwin
- private repos
- arion
- ??
2019-08-08 16:18:09 +02:00
