sphinx/sphinx-argparse can not interpret hyphen as underscore or vice-versa

[hanxiao]

Argument is defined with hyphen in argparse, e.g. --timeout-ready. In Python, this argument is auto converted to timeout_ready. So the user often expects to find the result by searching either: with hyphen or with underscore.

However, right now only the timeout-ready query gives the full result.

Result on timeout_ready:
https://docs.jina.ai/search.html?q=timeout_ready&check_keywords=yes&area=default#

Result on timeout-ready:
https://docs.jina.ai/search.html?q=timeout-ready&check_keywords=yes&area=default#

I guess some kind of alias needs to be added for hyphen and underscore, but at where? Should it be implemented in argparse, or sphinx-argparse, or sphinx, or doc theme level?

Original issue link: jina-ai/jina#402 (comment)

[eric-wieser]

As mentioned in sphinx-doc/sphinx#7648 (comment), I think the actual report here is that the value of action.dest (which just happens to default to swapping - for _) is not present anywhere in the generated docs.

Perhaps that's deliberate though, since dest is an implementation detail, not a property of the interface being documented.