Support sphinx doc strings

[rchiodo]

          @jakebailey I've created a new issue for an actual bug related to missing newlines for "key" and "keyword" parameter descriptions. These are valid syntax and break the current implementation of the docstring hover for sphinx format: https://github.com/microsoft/pylance-release/issues/2002

---

For the sake of not making new duplicate tickets, I would like to continue the discussion that is exactly related to "The Sphinx docstring hover may be more pretty". The Sphinx website shows an example rendering of how their syntax is meant to be used: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists

This is the expected rendering, which would bring it to parity with the same feature in PyCharm and match Sphinx's documentation.

Originally posted by @jeremyvital4 in #1113 (comment)

[rchiodo]

That comment had 21 upvotes before I created this.

[debonte]

Moving this issue to discussion as an enhancement request for comments and upvotes.

[TurnrDev]

I too would love to see some proper docstring support in VSCode, it's hideous looking at unparsed strings

[StellaHuang95]

Another similar request from user: #4445

[dill0wn]

Like most of Python, sphinx provided a feature that the python spec did not handle. Many older codebases use sphinx (as well as most(all?) readthedocs sites) to provide docstrings.

Are there any docstring comment formats that are formatted/rendered by pylance?

[rchiodo]

We support a number of formats but they're not rendered to the extent described above. The list we currently have is:

• Epytext
• reST
• Google doc strings

Mostly the formatting we do is to make sure line feeds are correct and spacing is consistent.

[rchiodo]

This should be implemented now under the python.analysis.supportRestructuredText option.