Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sphinx autodoc shows sync wrapped methods as async #422

Closed
jacobtomlinson opened this issue Jul 1, 2024 · 0 comments · Fixed by #430
Closed

Sphinx autodoc shows sync wrapped methods as async #422

jacobtomlinson opened this issue Jul 1, 2024 · 0 comments · Fixed by #430
Labels
bug Something isn't working documentation Improvements or additions to documentation typing

Comments

@jacobtomlinson
Copy link
Member

jacobtomlinson commented Jul 1, 2024

Which project are you reporting a bug for?

kr8s

What happened?

When sphinx autodoc generates the API reference it doesn't know about the kr8s._async_utils.sync decorator and how it converts corotuines to normal functions.

So for example kr8s.objects.Pod.ready() is listed as an async function when it is not.

We may need to write a plugin for sphinx to add knowledge of this wrapping.

Anything else?

No response

@jacobtomlinson jacobtomlinson added bug Something isn't working documentation Improvements or additions to documentation typing labels Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation typing
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant