pdoc icon indicating copy to clipboard operation
pdoc copied to clipboard

Support Sphinx / reStructuredText / reST args format

Open USSX-Hares opened this issue 6 years ago • 2 comments

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

USSX-Hares avatar Sep 22 '19 01:09 USSX-Hares

If you want to work on it and contrib a PR, I'd have a look.

kernc avatar Sep 22 '19 14:09 kernc

Some ideas/guidelines for the future implementer in https://github.com/pdoc3/pdoc/pull/198#issuecomment-627942049.

kernc avatar Oct 17 '20 11:10 kernc