Where is the API docs?

2026-02-02

API docs is generated from source code comments, and can be read online at MaixPy API on Sipeed Wiki.

If you want to preview API doc offline, there are two ways:

  1. Download offline docs file(maixpy_vx.x.x_doc.zip) from MaixPy releases page.
  2. Build MaixPy project, and API doc will be generated in MaixPy/docs/api/ directory.