Skip to content
This repository has been archived by the owner on Apr 26, 2023. It is now read-only.

Request: Handle markdown header for sections #41

Open
ws1088 opened this issue Oct 18, 2022 · 0 comments
Open

Request: Handle markdown header for sections #41

ws1088 opened this issue Oct 18, 2022 · 0 comments

Comments

@ws1088
Copy link

ws1088 commented Oct 18, 2022

Hi,
I am using Google style docstring in vscode and would like to write docstring for vscode intellisense and sphinx to generation HTML documentations. This is a typical docstring:

def test(a:int, b:bool) -> float:
    """_summary_

    ### Args:
        `a` (int): _description_
        `b` (bool): _description_

    ### Raises:
        `ValueError`: _description_
        `ZXValueError`: _description_

    ### Returns:
        `float`: _description_
    """    

I would like to see if napoleon can treat ## Args: or ### Args: as Args section in sphinx?

Looks like the change would be here: https://github.com/sphinx-contrib/napoleon/blob/master/sphinxcontrib/napoleon/docstring.py#L36

Would you accept such change?
Thanks!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant