Function's signatures get backslashes on stars (*) after updating sphinx to 3.0.0

[sciunto]

Describe the bug

In scikit-image, we noticed the appearance of backslashes in the signatures of our functions after updating to sphinx 3.0.0

sphinx 2.4.4:

sphinx 3.0.0:

Original bug report in scikit-image: scikit-image/scikit-image#4566

[tk0miya]

Sorry for the inconvenience. Since 3.0, we've stopped to remove backslashes from the signature. So please remove them from your signature. To keep backward compatibility, we also provide strip_signature_backslash to remove them like before.
Thanks,

[sciunto]

Thanks for the quick reply and the solution @tk0miya !

Actually, I'm not sure to understand fully what you mean by "please remove them from your signature" because there is no backslash in our python files (eg https://github.com/scikit-image/scikit-image/blob/v0.16.1/skimage/metrics/_adapted_rand_error.py#L7)

Nevertheless, I set to True the option you indicate and it solves the issue. Thanks for that!

[tk0miya]

Sorry for lack of my word. I guess you're using a 3rd party extension to convert your python script to reST document. So what I meant is that it would be better to remove backslashes "from the extension".

[sciunto]

Thank you for your explanations. I'm closing this issue.

[tk0miya]

@sciunto I'd like to know what tool or extension do you use to generate these pages. Do you know that?

[sciunto]

@tk0miya Our list of dependencies for the documentation is here: https://github.com/scikit-image/scikit-image/blob/master/requirements/docs.txt
We rely on numpydoc for these pages, which is largely used in scientific applications.

[tk0miya]

Thank you for letting me know. I'll send a patch to numpydoc not to need to use the strip_signature_backslash setting.

[sciunto]

Awesome! Thank you @tk0miya !

[sciunto]

Please, paste the link in this issue, so I can follow up.