module documentation

Undocumented

Function doc2html Undocumented
Function test​_parsed​_type Undocumented
Function test​_parsed​_type​_convert​_obj​_tokens​_to​_stan Undocumented
Function test​_processtypes Currently, numpy and google type parsing happens both at the string level with pydoctor.napoleon.docstring.TypeDocstring and at the docutils nodes ParsedTypeDocstring for type fields (``type`` and ``rtype``).
Function test​_processtypes​_corner​_cases The corner cases does not trigger any warnings because they are still valid types.
Function test​_processtypes​_more Undocumented
Function test​_processtypes​_warning​_unexpected​_element Undocumented
Function test​_processtypes​_with​_system Undocumented
Function test​_to​_node​_markup Undocumented
Function test​_types​_to​_node​_no​_markup Undocumented
Function typespec2htmlvianode Undocumented
Function typespec2htmlviastr Undocumented
def doc2html(doc, markup, processtypes=False):

Undocumented

Parameters
doc:strUndocumented
markup:strUndocumented
processtypes:boolUndocumented
Returns
strUndocumented
def test_parsed_type():

Undocumented

def test_parsed_type_convert_obj_tokens_to_stan():

Undocumented

def test_processtypes(capsys):
Currently, numpy and google type parsing happens both at the string level with pydoctor.napoleon.docstring.TypeDocstring and at the docutils nodes ParsedTypeDocstring for type fields (``type`` and ``rtype``).
Parameters
capsys:CapSysUndocumented
def test_processtypes_corner_cases(capsys):

The corner cases does not trigger any warnings because they are still valid types.

Warnings should be triggered in pydoctor.napoleon.docstring.TypeDocstring._trigger_warnings, we should be careful with triggering warnings because whether the type spec triggers warnings is used to check is a string is a valid type or not.

Parameters
capsys:CapSysUndocumented
def test_processtypes_more():

Undocumented

def test_processtypes_warning_unexpected_element(capsys):

Undocumented

Parameters
capsys:CapSysUndocumented
def test_processtypes_with_system(capsys):

Undocumented

Parameters
capsys:CapSysUndocumented
def test_to_node_markup():

Undocumented

def test_types_to_node_no_markup():

Undocumented

def typespec2htmlvianode(s, markup):

Undocumented

Parameters
s:strUndocumented
markup:strUndocumented
Returns
strUndocumented
def typespec2htmlviastr(s):

Undocumented

Parameters
s:strUndocumented
Returns
strUndocumented