Skip to content

Support Sphinx / reStructuredText / reST args format #110

@USSX-Hares

Description

def func(s, test):
    """
    Returns `True` if the string length is greater than the given integer.
    
    :param s: str
    :param test: int
    :return: bool
    """
    
    pass

This is default docstring style used in many editors.

Expected Behavior

Something like that:
image

Actual Behavior

image

Additional info

  • pdoc version: 0.6.3

Activity

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

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions