sphinx.util.docfields.Field

class documentation

class Field:

Known subclasses: sphinx.domains.python.PyField, sphinx.util.docfields.GroupedField

A doc field that is never grouped. It can have an argument or not, the argument can be linked using a specified rolename. Field should be used for doc fields that usually don't occur more than once.

The body can be linked using a specified bodyrolename if the content is just a single inline or text node.

Example:

:returns: description of the return value
:rtype: description of the return type

Method	`__init__`	Undocumented
Method	`make_entry`	Undocumented
Method	`make_field`	Undocumented
Method	`make_xref`	Undocumented
Method	`make_xrefs`	Undocumented
Class Variable	`is_grouped`	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, has_arg=True, rolename=None, bodyrolename=None):

overridden in sphinx.util.docfields.GroupedField

Undocumented

Parameters
name:`str`	Undocumented
names:`Tuple[str, ...]`	Undocumented
label:`str`	Undocumented
has_arg:`bool`	Undocumented
rolename:`str`	Undocumented
bodyrolename:`str`	Undocumented

def make_entry(self, fieldarg, content):

Undocumented

Parameters
fieldarg:`str`	Undocumented
content:`List[Node]`	Undocumented
Returns
`Tuple[str, List[Node]]`	Undocumented

def make_field(self, types, domain, item, env=None, inliner=None, location=None):

overridden in sphinx.util.docfields.GroupedField

Undocumented

Parameters
types:`Dict[str, List[Node]]`	Undocumented
domain:`str`	Undocumented
item:`Tuple`	Undocumented
env:`BuildEnvironment`	Undocumented
inliner:`Inliner`	Undocumented
location:`Node`	Undocumented
Returns
`nodes.field`	Undocumented

def make_xref(self, rolename, domain, target, innernode=addnodes.literal_emphasis, contnode=None, env=None, inliner=None, location=None):

Undocumented

Parameters
rolename:`str`	Undocumented
domain:`str`	Undocumented
target:`str`	Undocumented
innernode:`Type[TextlikeNode]`	Undocumented
contnode:`Node`	Undocumented
env:`BuildEnvironment`	Undocumented
inliner:`Inliner`	Undocumented
location:`Node`	Undocumented
Returns
`Node`	Undocumented

def make_xrefs(self, rolename, domain, target, innernode=addnodes.literal_emphasis, contnode=None, env=None, inliner=None, location=None):

Undocumented

Parameters
rolename:`str`	Undocumented
domain:`str`	Undocumented
target:`str`	Undocumented
innernode:`Type[TextlikeNode]`	Undocumented
contnode:`Node`	Undocumented
env:`BuildEnvironment`	Undocumented
inliner:`Inliner`	Undocumented
location:`Node`	Undocumented
Returns
`List[Node]`	Undocumented

is_grouped: bool =

overridden in sphinx.util.docfields.GroupedField

Undocumented

is_typed: bool =

overridden in sphinx.util.docfields.TypedField

Undocumented

bodyrolename =

Undocumented

has_arg =

Undocumented

label =

Undocumented

name =

Undocumented

names =

Undocumented

rolename =

Undocumented