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

[hanxiao]

Describe your problem

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#

What is your guess?

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 post: #395 (comment)
sphinx-argparse: alex-rudakov/sphinx-argparse#124
sphinx: sphinx-doc/sphinx#7648 (comment)

Environment

Screenshots

[jina-bot]

This issue is stale because it has been open 20 days with no activity. Remove stale label or comment or this will be closed in 4 days