zope.interface.document

Package zope :: Package interface :: Module document

[show private | hide private]

Module zope.interface.document

Pretty-Print an Interface object as structured text (Yum)

This module provides a function, asStructuredText, for rendering an interface as structured text.

$Id: document.py,v 1.2 2005/06/24 16:52:37 nyergler Exp $

Function Summary
	`_justify_and_indent(text, level, munge, width)` indent and justify text, rejustify (munge) if specified
	`_trim_doc_string(text)` Trims a doc string to make it format correctly with structured text.
	`asStructuredText(I, munge)` Output structured text format.

Variable Summary
`str`	`_trans` = `'\x00\x01\x02\x03\x04\x05\x06\x07\x08\t \x0b\x0...`

Function Details

indent and justify text, rejustify (munge) if specified

Trims a doc string to make it format correctly with structured text.

Output structured text format. Note, this will wack any existing 'structured' format of the text.

Variable Details

Type:: str
Value:: '\x00\x01\x02\x03\x04\x05\x06\x07\x08\t \x0b\x0c \x0e\x0f\x10\x11\x12\\ x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f !"#$%&\'()*+,-./01\ 23456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuv\ wxyz{|}~\x7f\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8a\x8b\x8c\x8d\x\ 8e\x8f\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9a\x9b\x9c\x9d\x9e\x9f\ \xa0\xa1\xa2\xa3\xa4\xa5\xa6\xa7\xa8\xa9\xaa\xab\xac\xad\xae\xaf\xb0\x\ b1\xb2\xb3\xb4\xb5\xb6\xb7\xb8\xb9\xba\xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\ \xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf\xd0\xd1\xd2\xd3\x\ ...

Generated by Epydoc 2.1 on Fri Jun 24 12:01:26 2005