kr8s-org / kr8s

A batteries-included Python client library for Kubernetes that feels familiar for folks who already know how to use kubectl
https://kr8s.org
BSD 3-Clause "New" or "Revised" License
839 stars 45 forks source link

Add autodoc for `kr8s.asyncio` #423

Closed jacobtomlinson closed 4 months ago

jacobtomlinson commented 4 months ago

Which project are you reporting a bug for?

kr8s

What happened?

Currently we exclude kr8s.asyncio from the Sphinx autodoc. It would be good to include this properly.

https://github.com/kr8s-org/kr8s/blob/99556dd4e1ab83aaddf300e3d2801e5ad81ee0ca/docs/conf.py#L53

We should also fix the sync API showing as async in #422 to make it more clear that there are two different APIs when looking at the API reference.

Anything else?

No response