From e7a87f03b6bf37d1eaa75e88d7b405837e12c1a2 Mon Sep 17 00:00:00 2001
From: Limao Chang <80520563+LimaoC@users.noreply.github.com>
Date: Fri, 16 Aug 2024 14:46:12 +1000
Subject: [PATCH] docs: add sphinx-apidoc to doc build instructions

---
 README.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 000d49b..4113c86 100644
--- a/README.md
+++ b/README.md
@@ -89,9 +89,13 @@ poetry run black client/models/pose_detection/classification.py
 To build the docs locally, run from the root of the repo:
 
 ```bash
-cd docs && poetry run make html
+poetry run sphinx-apidoc -f -o docs/source/generated client &&
+cd docs &&
+poetry run make html
 ```
 
+The documentation is generated automatically from the source code, so it isn't stored in the repo (hence why we need to run `sphinx-apidoc`).
+
 ## Downloading ML Models
 From top-level directory.
 ```bash