Support Sphinx / reStructuredText / reST args format

pdoc3 / pdoc

:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects

https://pdoc3.github.io/pdoc/

GNU Affero General Public License v3.0

1.13k stars 145 forks source link

Support Sphinx / reStructuredText / reST args format #110

Open USSX-Hares opened 5 years ago

USSX-Hares commented 5 years ago

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:

Actual Behavior

Additional info

pdoc version: 0.6.3

kernc commented 5 years ago

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

kernc commented 3 years ago

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