Skip to content
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

Support Sphinx / reStructuredText / reST args format #110

Open
USSX-Hares opened this issue Sep 22, 2019 · 2 comments · May be fixed by #198 or #274
Open

Support Sphinx / reStructuredText / reST args format #110

USSX-Hares opened this issue Sep 22, 2019 · 2 comments · May be fixed by #198 or #274
Labels
enhancement New feature or request good first issue Good for newcomers Hacktoberfest https://hacktoberfest.digitalocean.com

Comments

@USSX-Hares
Copy link

USSX-Hares commented Sep 22, 2019 •
edited 

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
@kernc
Copy link
Member

kernc commented Sep 22, 2019 •
edited

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

@kernc kernc added the enhancement New feature or request label Sep 22, 2019
@kernc kernc changed the title Feature Request: Support reStructuredText-style docstrings Support reStructuredText Sep 22, 2019
This was referenced Feb 21, 2020
Closed
Closed
@SmirnGreg SmirnGreg linked a pull request May 13, 2020 that will close this issue
Open
@kernc kernc mentioned this issue Aug 15, 2020
Closed
@kernc kernc changed the title Support reStructuredText Support Sphinx / reStructuredText / reST args format Oct 17, 2020
@kernc kernc mentioned this issue Oct 17, 2020
Closed
@kernc kernc added good first issue Good for newcomers Hacktoberfest https://hacktoberfest.digitalocean.com labels Oct 17, 2020
@kernc
Copy link
Member

kernc commented Oct 17, 2020

Some ideas/guidelines for the future implementer in #198 (comment).

@devdrian devdrian linked a pull request Oct 18, 2020 that will close this issue
Open
@kernc kernc mentioned this issue Feb 25, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers Hacktoberfest https://hacktoberfest.digitalocean.com
Milestone
No milestone
2 participants
@kernc @USSX-Hares