Skip to content
This repository has been archived by the owner on Dec 8, 2024. It is now read-only.

Commit

Permalink
docs: add sphinx-apidoc to doc build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
LimaoC committed Aug 16, 2024
1 parent 6f89db6 commit e7a87f0
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e7a87f0

Please sign in to comment.