From 21dbf307d1501147bb668db75cbe4eb4b68fe294 Mon Sep 17 00:00:00 2001 From: Jerome Kelleher Date: Thu, 5 Mar 2026 12:27:02 +0000 Subject: [PATCH] Update dev docs Closes #595 --- docs/development.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/development.md b/docs/development.md index bb68c427..5518efaf 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,20 +1,23 @@ # Development -To run the development dependencies use +See the [tskit developer documentation](https://tskit.dev/tskit/docs/stable/development.html) +for the general development workflow (git, prek, testing, documentation). + +Install development dependencies with: ``` -python3 -m pip install .[dev] +$ uv sync ``` -To run the unit tests, use +Run the unit tests with: ``` -python3 -m pytest +$ uv run pytest ``` -You may need to regenerate some cached test fixtures occasionaly (particularly -if getting cryptic errors when running the test suite). To do this, run +You may need to regenerate some cached test fixtures occasionally (particularly +if getting cryptic errors when running the test suite). To do this, run: ``` rm -fR tests/data/cache/