Skip to content

Update dev docs #597

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.

Sign up for GitHub

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

Merged
jeromekelleher merged 1 commit into from
Mar 5, 2026
Merged

Update dev docs #597

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 9 additions & 6 deletions docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/
Expand Down