mirrors/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2024-12-14 11:57:55 +00:00
Code Activity

programs.texlive: extend documentation of options

Browse source 
The options were barely documented until now, making it unnecessarily hard for people even somewhat familiar with other, similar modules to use this one.
This is especially because, intuitively, `packageSet` & `extraPackages` can be misunderstood
and neither of their descriptions described their advantages.
The enable option did not explain the module‘s purpose.
I heavily expanded the option’s descriptions which hopefully makes this module useable to newcomers without resorting to look into the Nix code of the module.
This commit is contained in:
Felix Stupp 2024-08-23 11:41:21 +02:00 committed by GitHub
parent 2598861031
commit 2437f8e4e0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 25 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
modules/programs/texlive.nix
View file

@ -14,12 +14,25 @@ in {
options = {
programs.texlive = {
enable = mkEnableOption "TeX Live";
enable = mkEnableOption ''
TeX Live package customization.
This module allows you to select which texlive packages you want to install.
Start by exteding {option}`programs.texlive.extraPackages`.
'';
packageSet = mkOption {
default = pkgs.texlive;
defaultText = literalExpression "pkgs.texlive";
description = "TeX Live package set to use.";
defaultText = literalExpression ''
pkgs.texlive # corresponds to packages in pkgs.texlivePackages
'';
description = ''
TeX Live package set to use.
This is used in the option {option}`programs.texlive.extraPackages`.
Normally you do not want to change this from the default
except if you want to use texlive packages from a different nixpkgs release than your config’s default.
'';
};
extraPackages = mkOption {
@ -28,7 +41,15 @@ in {
example = literalExpression ''
tpkgs: { inherit (tpkgs) collection-fontsrecommended algorithms; }
'';
description = "Extra packages available to TeX Live.";
description = ''
Extra packages which should be appended.
{option}`programs.texlive.packageSet` will be passed to this function.
In case you changed your `packageSet`,
you can find all available packages to select from
in nixpkgs under `pkgs.texlivePackages`,
see [here to search for them in the latest release](https://search.nixos.org/packages?type=packages&query=texlivePackages.).
'';
};
package = mkOption {