Documentation Tools

This module defines miscellaneous utility functions.

joinLinks(links, sep=', ', last=None, sort=False)

Returns a string joining links as reStructuredText.

joinRepr(items, sep=', ', last=None, sort=False)

Returns a string joining representations of items.

joinTerms(terms, sep=', ', last=None, sort=False)

Returns a string joining terms as reStructuredText.

tabulate(*cols, **kwargs)

Returns a table for columns of data.

Parameters:

• header (bool) – make first row a header, default is True
• width (int) – 79

Kwargs space:

number of white space characters between columns, default is 2

wrapText(text, width=70, join='\n', **kwargs)

Returns wrapped lines from textwrap.wrap() after *join*ing them.