zope.configuration.docutils

Helper Utility to wrap a text to a set width of characters

zope.configuration.docutils.wrap(text, width=78, indent=0)[source]

Makes sure that we keep a line length of a certain width.

Examples:

>>> from zope.configuration.docutils import wrap
>>> print(wrap('foo bar')[:-2])
foo bar
>>> print(wrap('foo bar', indent=2)[:-2])
  foo bar
>>> print(wrap('foo bar, more foo bar', 10)[:-2])
foo bar,
more foo
bar
>>> print(wrap('foo bar, more foo bar', 10, 2)[:-2])
  foo bar,
  more foo
  bar
zope.configuration.docutils.makeDocStructures(context) → namespaces, subdirs[source]

Creates two structures that provide a friendly format for documentation.

namespaces is a dictionary that maps namespaces to a directives dictionary with the key being the name of the directive and the value is a tuple: (schema, handler, info).

subdirs maps a (namespace, name) pair to a list of subdirectives that have the form (namespace, name, schema, info).