Documenting static argument & return types of JIT-compiled functions via sphinx?

I am heavily using sphinx and autodoc to document code. In this context, there is the really cool sphinx-autodoc-typehints plugin which even picks up Python type annotations and makes them part of the documentation. Because I typically statically type a lot of my JIT-compiled functions via numba’s jit and njit decorators instead of using Python type annotations, I was wondering if there was a tool or plugin for sphinx similar to sphinx-autodoc-typehints that would be able to pick up the types specified via numba.

1 Like

Unrelated, but from the issue you opened upstream, notice that:

in general it is recommended not to pass any explicit signature to @jit . Just let Numba infer the most adequate types.

(source: Cannot use cffi.from_buffer when explicitly passing signature to JIT · Issue #1691 · numba/numba · GitHub)

I don’t know if the official advice has changed since 2016, but just FYI.