Documentation Tools
This module defines miscellaneous utility functions.
- prody.utilities.doctools.joinLinks(links, sep=', ', last=None, sort=False)[source]
Returns a string joining links as reStructuredText.
- prody.utilities.doctools.joinRepr(items, sep=', ', last=None, sort=False)[source]
Returns a string joining representations of items.
- prody.utilities.doctools.joinTerms(terms, sep=', ', last=None, sort=False)[source]
Returns a string joining terms as reStructuredText.
- prody.utilities.doctools.tabulate(*cols, **kwargs)[source]
Returns a table for columns of data.
- Keyword Arguments:
header – make first row a header, default is True
width – 79
- Kwargs space:
number of white space characters between columns, default is 2
- prody.utilities.doctools.wrapText(text, width=70, join='\n', **kwargs)[source]
Returns wrapped lines from
textwrap.wrap()after *join*ing them.