From 3349da551fc5509530757e9e7a6f8bdb1f3cb888 Mon Sep 17 00:00:00 2001 From: Limao Chang <80520563+LimaoC@users.noreply.github.com> Date: Fri, 16 Aug 2024 13:44:00 +1000 Subject: [PATCH] docs: add instructions for building documentation locally --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index a9a1842..6b0882f 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,14 @@ To style individual files, you can use poetry run black client/models/pose_detection/classification.py ``` +## Documentation + +To build the docs locally, run from the root of the repo: + +```bash +cd docs && make html +``` + ## Downloading ML Models From top-level directory. ```bash