pydoctor.epydoc.markup._napoleon.NapoelonDocstringParser

class documentation

class NapoelonDocstringParser: (source)

View In Hierarchy

Parse google-style or numpy-style docstrings.

First wrap the pydoctor.napoleon converter classes, then call pydoctor.epydoc.markup.restructuredtext.parse_docstring with the converted reStructuredText docstring.

If the Documentable instance is an Attribute, the docstring will be parsed differently.

Method __init__ No summary
Method parse_google_docstring Parse the given docstring, which is formatted as Google style docstring. Return a ParsedDocstring representation of its contents.
Method parse_numpy_docstring Parse the given docstring, which is formatted as NumPy style docstring. Return a ParsedDocstring representation of its contents.
Instance Variable obj Undocumented
Static Method _parse_docstring_obj Helper method to parse GoogleDocstring or NumpyDocstring objects.
Method _parse_docstring Undocumented
def __init__(self, obj=None): (source)
Parameters
obj:Optional[Documentable]Documentable object we're parsing the docstring for.
def parse_google_docstring(self, docstring, errors, processtypes=True): (source)

Parse the given docstring, which is formatted as Google style docstring. Return a ParsedDocstring representation of its contents.

Parameters
docstring:strThe docstring to parse
errors:List[ParseError]A list where any errors generated during parsing will be stored.
processtypes:boolUndocumented
Returns
ParsedDocstringUndocumented
def parse_numpy_docstring(self, docstring, errors, processtypes=True): (source)

Parse the given docstring, which is formatted as NumPy style docstring. Return a ParsedDocstring representation of its contents.

Parameters
docstring:strThe docstring to parse
errors:List[ParseError]A list where any errors generated during parsing will be stored.
processtypes:boolprocesstypes is always ``True`` for google and numpy docstrings.
Returns
ParsedDocstringUndocumented
obj = (source)

Undocumented

@staticmethod
def _parse_docstring_obj(docstring_obj, errors): (source)

Helper method to parse GoogleDocstring or NumpyDocstring objects.

Parameters
docstring_obj:GoogleDocstringUndocumented
errors:List[ParseError]Undocumented
Returns
ParsedDocstringUndocumented
def _parse_docstring(self, docstring, errors, docstring_cls): (source)

Undocumented

Parameters
docstring:strUndocumented
errors:List[ParseError]Undocumented
docstring_cls:Type[GoogleDocstring]Undocumented
Returns
ParsedDocstringUndocumented