Docstring alias for modules that mix bindings and pure Python

[jpreiss]

My project mixes pybind11 output with pure Python code. I follow the pattern in #1004 (comment) and #1004 (comment): give an "ugly" name for the pybind11 module, then in the top-level module's __init__.py have

from _ugly_name import Class

__all__ = ["Class"]

However, the docstrings generated look like:

method_name(self: _ugly_name.Class) -> int

It would be great if I could choose a different module name.

Since pybind11 has no awareness of how the bindings fit into the larger package, we cannot hope to do this automatically. What if pybind11::options had some method like set_module_doc_alias(char const *) that would allow the user to choose how the module's name appears in generated docstrings?

[tvatter]

@jpreiss Did you find a solution to this issue?

[jpreiss]

unfortunately not :(

[tvatter]

The trick suggested here worked for me.