From 1aacbfa42eda203c07f8e47c2d9ff0f0264e153e Mon Sep 17 00:00:00 2001 From: Leni Aniva Date: Tue, 10 Dec 2024 16:40:07 -0800 Subject: [PATCH] doc: Add documentation about using wheel --- docs/setup.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/setup.md b/docs/setup.md index f1a4382..abe1df5 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -4,7 +4,13 @@ Install `poetry`. Then, run ```sh poetry build ``` -This builds a wheel of Pantograph which can then be installed. + +This builds a wheel of Pantograph in `dist` which can then be installed. For +example, a downstream project could have this line in its `pyproject.toml` + +```toml +pantograph = { file = "path/to/wheel/dist/pantograph-0.2.19-cp312-cp312-manylinux_2_40_x86_64.whl" } +``` To run the examples and experiments, setup a poetry shell: ```sh