sphinx.util.docfields.DocFieldTransformer

class documentation

class DocFieldTransformer: (source)

View In Hierarchy

Transforms field lists in "doc field" syntax into better-looking equivalents, using the field type definitions given on a domain.

Method __init__ Undocumented
Method transform Transform a single field list *node*.
Method transform_all Transform all field list children of a node.
Instance Variable directive Undocumented
Instance Variable typemap Undocumented
def __init__(self, directive): (source)

Undocumented

Parameters
directive:ObjectDescriptionUndocumented
def transform(self, node): (source)

Transform a single field list *node*.

Parameters
node:nodes.field_listUndocumented
def transform_all(self, node): (source)

Transform all field list children of a node.

Parameters
node:addnodes.desc_contentUndocumented
directive = (source)

Undocumented

typemap = (source)

Undocumented