Open ws1088 opened 1 year ago
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?
## Args:
### Args:
Args
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!
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:
I would like to see if napoleon can treat
## Args:
or### Args:
asArgs
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!