Skip to content

Combination of admonition, link, parameter type breaks long_description. #68

@songololo

Description

@songololo

Parsing the following doesn't work (long_description fails).

def mock_function(boo):
    """

    :::note
    Admonition with a [link](https://google.com).
    :::

    Parameters
    ----------
    boo: int
        baa

    """
    pass

Interestingly, removal of any of the following causes things to start working again:

  • link inside the admonition
  • admonition block wrappers - i.e. :::
  • parameter type information - i.e. int

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions