Warning admonition in docstrings not rendered on website

[vdusek]

Description

The Warning: admonition in Python docstrings is not being rendered as a warning box on the documentation website.

Example

In SqlStorageClient class docstring, there is a warning:

Warning:
    This is an experimental feature. The behavior and interface may change in future versions.

This warning block is present in the source code but does not appear as a rendered warning admonition in the API reference documentation.

Source code

Rendered page

[B4nan]

We'd have to transform the Python-specific syntax to what docusaurus understands:

https://docusaurus.io/docs/markdown-features/admonitions

Or we could just use it directly in the docstring to have full control?

[barjin]

I believe we're currently parsing Warning: and the indented section below as a Google docstring-style special section (see style guide here). That's why it's missing from the docs altogether.

With a bit of luck, we might be able to use the Docusaurus-style admonition directly in the docstring - although i'm not sure what it's gonna look like in IDE. I'll investigate a bit more.