Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: add direnv and .envrc instructions #289

Merged
merged 2 commits into from
Aug 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
"Dalitz",
"deadsnakes",
"defaultdict",
"direnv",
"dummifies",
"dummify",
"eigenstates",
Expand Down Expand Up @@ -204,6 +205,7 @@
"einsum",
"elif",
"endswith",
"envrc",
"epsabs",
"epsrel",
"eqnarray",
Expand Down
4 changes: 4 additions & 0 deletions docs/develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading