You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
NickleDave
changed the title
BUG: Outdated documentation (Contributors guide)
DOC: Fix dev env instructions in contributors' guide, and explain nox usage in other areas, e.g. tests
Nov 16, 2022
Thank you @ItamarFruchter for catching this and sorry again for the inconvenience
We need to do two things here:
fix that sections of "setting up a dev environment" to explain nox usage
also explain nox usage in other parts of that page, e.g. how to run tests + build docs
The "setting up a dev environment" should be updated like so
as a developer
This project uses the library nox
as a task runner,
to automate tasks like setting up a development environment.
Each task is represented as what nox calls a "session",
and you can run a session by invoking nox
at the command-line with the name of the session.
So, to set up a virtual environment for development
with songdkl installed in "editable" mode,
run the "dev" session.
We suggest using pipx
to install nox in an isolated environment,
so that nox can be accessed system-wide without affecting
anything else on your machine.
The 'Contributors Guide' section on the VAK documents is outdated, specifically working with the makefile.
The text was updated successfully, but these errors were encountered: