sphinx.util.docfields.GroupedField

class documentation

class GroupedField(Field): (source)

Known subclasses: sphinx.domains.python.PyGroupedField, sphinx.util.docfields.TypedField

A doc field that is grouped; i.e., all fields of that type will be transformed into one field with its body being a bulleted list. It always has an argument. The argument can be linked using the given *rolename*. GroupedField should be used for doc fields that can occur more than once. If *can_collapse* is true, this field will revert to a Field if only used once. Example:: :raises ErrorClass: description when it is raised

Method	`__init__`	Undocumented
Method	`make_field`	Undocumented
Class Variable	`is_grouped`	Undocumented
Instance Variable	`can_collapse`	Undocumented

Inherited from Field:

Method	`make_entry`	Undocumented
Method	`make_xref`	Undocumented
Method	`make_xrefs`	Undocumented
Class Variable	`is_typed`	Undocumented
Instance Variable	`bodyrolename`	Undocumented
Instance Variable	`has_arg`	Undocumented
Instance Variable	`label`	Undocumented
Instance Variable	`name`	Undocumented
Instance Variable	`names`	Undocumented
Instance Variable	`rolename`	Undocumented

def __init__(self, name, names=(), label=None, rolename=None, can_collapse=False): (source) ¶

overrides sphinx.util.docfields.Field.__init__

overridden in sphinx.util.docfields.TypedField

Undocumented

Parameters
name:`str`	Undocumented
names:`tuple[str, ...]`	Undocumented
label:`str`	Undocumented
rolename:`str`	Undocumented
can_collapse:`bool`	Undocumented

def make_field(self, types, domain, items, env=None, inliner=None, location=None): (source) ¶

overrides sphinx.util.docfields.Field.make_field

overridden in sphinx.util.docfields.TypedField

Undocumented

Parameters
types:`dict[str, list[Node]]`	Undocumented
domain:`str`	Undocumented
items:`tuple`	Undocumented
env:`BuildEnvironment`	Undocumented
inliner:`Inliner`	Undocumented
location:`Node`	Undocumented
Returns
`nodes.field`	Undocumented

is_grouped: bool = (source) ¶

overrides sphinx.util.docfields.Field.is_grouped

Undocumented

can_collapse = (source) ¶

Undocumented