Documentation Tools

This module defines miscellaneous utility functions.

Return a string joining links as reStructuredText.

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

Return a string joining representations of items.

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

Return a string joining terms as reStructuredText.

tabulate(*cols, **kwargs)[source]

Return 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)[source]

Return wrapped lines from textwrap.wrap() after joining them.

Read the Docs v: v1.5
Versions
latest
v1.5
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.