module documentation

Undocumented

Function filetext Undocumented
Function flatten Undocumented
Function get​HTMLOf Undocumented
Function is​_fs​_case​_sensitive Undocumented
Function test​_basic​_package Undocumented
Function test​_document​_code​_in​_init​_module Undocumented
Function test​_empty​_table Undocumented
Function test​_format​_decorators Test pages.format_decorators
Function test​_format​_signature Test pages.format_signature.
Function test​_hasdocstring Undocumented
Function test​_html​_template​_version Undocumented
Function test_is​Class​Node​Private A node for a private class with public subclasses is considered public.
Function test_is​Private A documentable object is private if it is private itself or lives in a private context.
Function test​_missing​_variable Undocumented
Function test_multiple​Inheritance​New​Class A class that has multiple bases has all methods in its MRO rendered.
Function test​_nonempty​_table Undocumented
Function test​_rest​_support Undocumented
Function test​_simple Undocumented
Function test​_template Undocumented
Function test​_template​_casing Undocumented
Function test​_template​_fromdir​_fromfile​_failure Undocumented
Function test​_template​_lookup​_add​_template​_allok Undocumented
Function test​_template​_lookup​_add​_template​_raises Undocumented
Function test​_template​_lookup​_add​_template​_warns Undocumented
Function test​_template​_lookup​_get​_template Undocumented
Function test​_template​_subfolders​_overrides Undocumented
Function test​_template​_subfolders​_write Undocumented
Function test​_template​_subfolders​_write​_casing Undocumented
Function test​_templatelookup​_casing Undocumented
Variable template​_dir Undocumented
def filetext(path):

Undocumented

Parameters
path:Union[Path, Traversable]Undocumented
Returns
strUndocumented
def flatten(t):

Undocumented

Parameters
t:FlattenableUndocumented
Returns
strUndocumented
def getHTMLOf(ob):

Undocumented

Parameters
ob:model.DocumentableUndocumented
Returns
strUndocumented
def is_fs_case_sensitive():

Undocumented

Returns
boolUndocumented
def test_basic_package(tmp_path):

Undocumented

Parameters
tmp​_path:PathUndocumented
def test_document_code_in_init_module():

Undocumented

def test_empty_table():

Undocumented

def test_format_decorators():
Test pages.format_decorators
def test_format_signature():
Test pages.format_signature.
Note
This test will need to be adapted one we include annotations inside signatures.
def test_hasdocstring():

Undocumented

def test_html_template_version():

Undocumented

def test_isClassNodePrivate():
A node for a private class with public subclasses is considered public.
@pytest.mark.parametrize('func', [isPrivate, isClassNodePrivate])
def test_isPrivate(func):
A documentable object is private if it is private itself or lives in a private context.
Parameters
func:Callable[[model.Class], bool]Undocumented
def test_missing_variable():

Undocumented

@pytest.mark.parametrize('className', ['NewClassThatMultiplyInherits', 'OldClassThatMultiplyInherits'])
def test_multipleInheritanceNewClass(className):
A class that has multiple bases has all methods in its MRO rendered.
Parameters
class​Name:strUndocumented
def test_nonempty_table():

Undocumented

def test_rest_support():

Undocumented

def test_simple():

Undocumented

def test_template():

Undocumented

def test_template_casing():

Undocumented

def test_template_fromdir_fromfile_failure():

Undocumented

def test_template_lookup_add_template_allok():

Undocumented

def test_template_lookup_add_template_raises():

Undocumented

def test_template_lookup_add_template_warns():

Undocumented

def test_template_lookup_get_template():

Undocumented

def test_template_subfolders_overrides():

Undocumented

def test_template_subfolders_write(tmp_path):

Undocumented

Parameters
tmp​_path:PathUndocumented
@pytest.mark.skipif(not is_fs_case_sensitive(), reason='This test requires a case sensitive file system.')
def test_template_subfolders_write_casing(tmp_path):

Undocumented

Parameters
tmp​_path:PathUndocumented
def test_templatelookup_casing():

Undocumented

template_dir =

Undocumented