New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open

songololo opened this issue Jun 14, 2022 · 0 comments

songololo commented Jun 14, 2022

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

The text was updated successfully, but these errors were encountered:

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