From 752335cbcf9654cc19286a3360fc627c8789421c Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Thu, 1 Aug 2024 21:23:23 +0200 Subject: [PATCH] DOC: add `direnv` and `.envrc` instructions --- .cspell.json | 2 ++ docs/develop.md | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/.cspell.json b/.cspell.json index 3674d17a..3ce23825 100644 --- a/.cspell.json +++ b/.cspell.json @@ -69,6 +69,7 @@ "Dalitz", "deadsnakes", "defaultdict", + "direnv", "dummifies", "dummify", "eigenstates", @@ -204,6 +205,7 @@ "einsum", "elif", "endswith", + "envrc", "epsabs", "epsrel", "eqnarray", diff --git a/docs/develop.md b/docs/develop.md index 96a1d51b..e6453e20 100644 --- a/docs/develop.md +++ b/docs/develop.md @@ -137,6 +137,10 @@ uv pip install -e . ::: :::: +:::{tip} +[Install `direnv`](https://direnv.net/docs/installation.html) if a repository contains a {file}`.envrc` file. This ensures that the appropriate environment is activates once you navigate into the repository! +::: + ### Editable installation When developing a package, it is most convenient if you install it in