How do I get Sphinx to recognize native module .pyi stubs?

[keltonhalbert]

I am using nanobind to create a native module. It adds doc to methods/classes/etc, but it is in a format that Sphinx is not a fan of. I had hoped to instead use the .pyi type stubs that get generated, but I can't get Sphinx to import them. It seems to be pulling from the .so instead. Any tips?

[AA-Turner]

Do you have a minimal reproducer? The relevant PR was #13253.

A

[keltonhalbert]

@AA-Turner So, I was actually juggling several issues at once, and when I wrote this, I did a pretty poor job of mentally separating them out. My apologies on that front.

It turns out, my problem was actually with autosummary, and the docstring formatting was fine.

I am using nanobind for native Python bindings and stubgen. The nanobind modules and submodules expose a doc string for the functions, which Sphinx sees/uses, but I was hoping to maybe force it to use the stubgen instead. Since the bindings and stubs are generated at compile time, I am generating the docs by importing instead of looking at source code, and that's probably why the .pyi stubs aren't used.

In regards to the autosummary issue...
If I use autodoc, it correctly uses autodoc_docstring_signature to handle the function signatures. It seems that autosumamry does not respect or use this feature, and so the results are pretty garbled and unusable. I think this could be remedied with a custom template?