Skip to content

Commit

Permalink
📝 docs: clarify some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jzazo committed May 13, 2024
1 parent 3a709c2 commit 7c64bd5
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/dev_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ eval "$(direnv hook bash)" # add to current shell
mkdir -p ~/.config/direnv/
cp .devcontainer/direnvrc ~/.config/direnv/direnvrc
```
When you enter the project folder, direnv will ask you to allow the `.envrc` file to be loaded.
Allow it by running `direnv allow`.


### [Pyenv](https://github.com/pyenv/pyenv)
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ run `poetry add <package>` to add a new dependency. Run `poetry update` to updat
Poetry will create a `.venv` folder with a virtual environment inside your project (configurable
with `poetry.toml`).
* To run tests, use `poetry run pytest`, or if you use [_direnv_](https://github.com/direnv/direnv)
and have enabled it, simply run `pytest`. See setting up your development environment below.
and have [enabled](dev_setup.md#direnv) it, simply run `pytest`.
* You will only get the `docs` folder if you enabled documentation builds in the _copier_ prompts.
Add your markdown documentation to the `docs` folder and run `bin/serve-docs` to see a live preview
(or `serve-docs` if you use _direnv_). Make changes to `.pages` to edit your navigation pane.
Expand Down

0 comments on commit 7c64bd5

Please sign in to comment.