sphinx.util.docfields.Field

class documentation

class Field: (source)

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

View In Hierarchy

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): (source)
overridden in sphinx.util.docfields.GroupedField

Undocumented

Parameters
name:strUndocumented
names:tuple[str, ...]Undocumented
label:strUndocumented
has_arg:boolUndocumented
rolename:strUndocumented
bodyrolename:strUndocumented
def make_entry(self, fieldarg, content): (source)

Undocumented

Parameters
fieldarg:strUndocumented
content:list[Node]Undocumented
Returns
tuple[str, list[Node]]Undocumented
def make_field(self, types, domain, item, env=None, inliner=None, location=None): (source)
overridden in sphinx.util.docfields.GroupedField

Undocumented

Parameters
types:dict[str, list[Node]]Undocumented
domain:strUndocumented
item:tupleUndocumented
env:BuildEnvironmentUndocumented
inliner:InlinerUndocumented
location:NodeUndocumented
Returns
nodes.fieldUndocumented
def make_xref(self, rolename, domain, target, innernode=addnodes.literal_emphasis, contnode=None, env=None, inliner=None, location=None): (source)

Undocumented

Parameters
rolename:strUndocumented
domain:strUndocumented
target:strUndocumented
innernode:type[TextlikeNode]Undocumented
contnode:NodeUndocumented
env:BuildEnvironmentUndocumented
inliner:InlinerUndocumented
location:NodeUndocumented
Returns
NodeUndocumented
def make_xrefs(self, rolename, domain, target, innernode=addnodes.literal_emphasis, contnode=None, env=None, inliner=None, location=None): (source)

Undocumented

Parameters
rolename:strUndocumented
domain:strUndocumented
target:strUndocumented
innernode:type[TextlikeNode]Undocumented
contnode:NodeUndocumented
env:BuildEnvironmentUndocumented
inliner:InlinerUndocumented
location:NodeUndocumented
Returns
list[Node]Undocumented
is_grouped: bool = (source)
overridden in sphinx.util.docfields.GroupedField

Undocumented

is_typed: bool = (source)
overridden in sphinx.util.docfields.TypedField

Undocumented

bodyrolename = (source)

Undocumented

has_arg = (source)

Undocumented

label = (source)

Undocumented

name = (source)

Undocumented

names = (source)

Undocumented

rolename = (source)

Undocumented