Ask a Question
Back to All

Looking for recommendations for automatic Python API (docstring) to readme.io markdown pages

We host our API documentation on readme (see here: https://docs.edgeimpulse.com/reference). While we use the OpenAPI integration for our REST API, we are also working on generating and hosting Python API documentation for our Python SDK. At the moment, I have been learning and tinkering with sphinx and pydoc-markdown for markdown generation. Neither seems to provide the output required for readme without modifications to their code or some custom add-ons.

Does anyone have any recommendations on tools that can read Python docstrings to produce good API documentation hosted on readme?