Skip to content

Google style¤

⚠ Work in Progress!¤

Google-style admonitions¤

With Google-style docstrings, any section that is not recognized will be transformed into its admonition equivalent. For example:

"""
Note:
    It looks like a section, but it will be rendered as an admonition.

Tip: You can even choose a title.
    This admonition has a custom title!
"""

Note

It looks like a section, but it will be rendered as an admonition.

You can even choose a title.

This admonition has a custom title!

See Napoleon's documentation. See the supported docstring sections on Griffe's documentation.