search

lifeomic / phc-sdk-py

The phc-sdk-py is a developer kit for interfacing with the PHC API on Python 3.8 and above.
https://lifeomic.github.io/phc-sdk-py/index.html
MIT License
1 stars 2 forks source link

pdoc -> sphinx #194

Closed shawnzhu closed 8 months ago

shawnzhu commented 1 year ago

The motivation is improve the UX of sdk document for target users.

When adding more capability into this sdk for target users like a ML engineer, it needs getting started guide and dev guide to start. Existing solution via pdoc is API doc focused and the hierarchy is from the README.md. I'm looking for a better tool so I'd give sphinx a try.

Things in my mind:

  1. generate document via sphinx instead of pdoc
  2. improve TOC for target audiences (users and contributors/maintainers)
  3. include new getting started guide for ML engineers to use the Patient ML feature