nix-community/dream2nix
1
1
Fork 0
mirror of https://github.com/nix-community/dream2nix.git synced 2024-12-22 22:11:50 +03:00
Code Issues Projects Releases Wiki Activity

docs: add description to editables(ShellHook)

Browse Source
This commit is contained in:
phaer 2024-07-11 16:42:01 +02:00
parent ee8e6ef05f
commit 3c78e8aca3
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
modules/dream2nix/python-editables/interface.nix
View File

@ -7,10 +7,24 @@
in {
options = {
editables = lib.mkOption {
description = ''
An attribute set mapping package names to absolute paths of source directories
which should be installed in editable mode in [editablesShellHook](#pipeditablesshellhook).
i.e.
```
pip.editables.charset-normalizer = "/home/user/src/charset-normalizer".
```
The top-level package is added automatically.
'';
type = t.attrsOf t.str;
};
editablesShellHook = lib.mkOption {
description = ''
A shellHook to be included into your devShells to install [editables](#pipeditables)
'';
type = t.str;
readOnly = true;
};