Example projects where stubs override builtin annotations

[tgross35]

Hello everyone,

I am attempting to follow the "if you need other python files" layout in the docs appendix, but have been completely unsuccessful getting the stub file to take precedence over the builtin definition. That is, myfunction.__doc__ returns the rust docstring rather than what's in the .pyi. This also means that sphinx cannot correctly generate autodocs.

So, is there a good example project that demonstrates how to correctly use stub files?

For reference, my existing nonworking project is located here: https://github.com/pluots/stringmetrics/tree/5e494f0969b2b6dbc189696fc59365c8c2272032/crates/stringmetrics_py, which has an identical layout to what is in the docs.

[messense]

I don't think sphinx autodoc supports .pyi file right now, there is a PR to add the feature, see sphinx-doc/sphinx#4824.

You could try sphinx-autoapi.