Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 832 Bytes

File metadata and controls

28 lines (20 loc) · 832 Bytes

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:

=== "Docstring" ```python """ 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!
"""
```

=== "Result" 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!

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