about summary refs log tree commit diff
path: root/nixos/lib/make-options-doc
AgeCommit message (Collapse)AuthorFilesLines
2021-04-13nixosOptionsDoc: add markdown formattingPacman991-0/+26
2020-09-02nixos/lib/make-options-doc: remove loaOf subsrnhmjoj1-1/+1
Remove the substitution for the <name?> placeholder used by loaOf, now that the type has been deprecated.
2020-08-03nixos/manual: improve error message for invalid values in `relatedPackages'Maximilian Bosch1-3/+3
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-04-02Revert "make-options-doc: fix string context issues"Jan Tojnar1-1/+1
This reverts commit 3c15d578d4271142d7e596b9dc708cf07da48fa8. See https://github.com/NixOS/nixpkgs/issues/83863
2020-03-24Compress optionsJSON using brotliEelco Dolstra1-0/+4
2019-11-23make-options-doc: fix string context issuesDima1-1/+1
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-08-28treewide: remove redundant recvolth1-1/+1
2019-08-12pkgs.lib -> libDomen Kožar1-3/+3
2019-08-10make-options-doc: add asciidoc variantDomen Kožar1-0/+38
2019-08-10make-options-doc: expose Nix setDomen Kožar1-4/+5
2019-08-08Extract NixOS options documentation generation to a functionDomen Kožar3-0/+476
Motivation is to support other repositories containing nixos modules that would like to generate options documentation: - nix-darwin - private repos - arion - ??