From 9fba513e45cdd3595616cc03055f5c43ea8a8a7e Mon Sep 17 00:00:00 2001 From: Jerome Kelleher Date: Thu, 5 Mar 2026 12:41:21 +0000 Subject: [PATCH] Update docs --- docs/_toc.yml | 3 +++ docs/development.md | 22 ++++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 docs/development.md diff --git a/docs/_toc.yml b/docs/_toc.yml index e811ea9..d2b2df3 100644 --- a/docs/_toc.yml +++ b/docs/_toc.yml @@ -7,3 +7,6 @@ parts: - file: api - file: CITATION - file: CHANGELOG +- caption: Development + chapters: + - file: development diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 0000000..d8e6b98 --- /dev/null +++ b/docs/development.md @@ -0,0 +1,22 @@ +(sec_development)= + +# Development + +All contributions, bug reports, documentation improvements and ideas are welcome. If you think +there is anything missing, please open an [issue](https://github.com/tskit-dev/tscompare/issues) +or [pull request](https://github.com/tskit-dev/tscompare/pulls) on GitHub. + +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: + +``` +uv sync +``` + +Run the tests with: + +``` +uv run pytest +```