bakdata / kpops

Deploy Kafka pipelines to Kubernetes
https://bakdata.github.io/kpops
MIT License
12 stars 1 forks source link

Generate API documentation using `mkdocstrings` #492

Closed raminqaf closed 2 days ago

raminqaf commented 1 month ago

Use https://github.com/mkdocstrings/mkdocstrings to create docs for the new's KPOps Python API

disrupted commented 1 month ago

as a baseline for the first iteration I'd say we should include

disrupted commented 1 month ago

had a quick play with it (mainly for L&L) https://github.com/bakdata/kpops/tree/docs/mkdocstrings