autodoc_docstring_signature with overloaded methods

[rmcgibbo]

When using swig to wrap C++ classes for python, if they have overloaded methods, I believe the convention is to place the signatures for each of the overloaded C++ methods at the start of the docstring. Currently, autodoc_docstring_signature can only pick up the first one. It would be nice to be able to pick up all of them.

[tk0miya]

Why don't overloaded methods have correct signature? I'd like to know why do you want to use autodoc_docstring_signature. I think it is workaround for special case.

[3nids]

is there any workaround for this?

[tk0miya]

@3nids Could you let me know your problem in detail please. I still don't understand what is real problem of this issue. Is there any minimal reproducible example?

[3nids]

We use Sphinx to document Python bindings of a Qt C++ API.
We have overloaded methods in the API:

for instance, the method getFeatures has 4 overloaded signatures.
The generation documentation appends the 4 signatures with the 4 docstrings.
This produces this output in the docs:

[tk0miya]

Thank you for explanation. I just understand what happened. But Sphinx does not support multiple signatures for python objects unfortunately. So there are no workarounds AFAIK. I'll consider how to realize this feature later.

[3nids]

Would it be possible to sponsor such feature?

[tk0miya]

Now Sphinx does not join any sponsorship programs. So no way to pay a prize to this feature.

off topic: Personally, I just started GitHub sponsors program in this week. So sponsors are always welcome. But I'd not like to change order by sponsor requests...