Skip to content

An option to control whether the admonitions in python docstring should be collapsed #22

Description

@asakiasako

Is your feature request related to a problem? Please describe.
When I use admonitions in python docstring like this:

"""
Note:
    Details ...
"""

I noticed that an collapsed admonitions is rendered in the browser now.

I can use !!! note to make a uncollapsed admonition, but this will make the docstring strange for human reading.

Describe the solution you'd like
The information contained in 'Note' or 'Tips' or other admonitions are usually important information, and we don't want our users to miss them, so I think at least we have a choise to choose whether it should be collapsed.


Platform: Windows 10
mkdocstrings == 0.19.0
mkdocstrings-python == 0.7.0
griffe == 0.20.0

I don't know if I described the situation clearly 😂

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions