pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring

class documentation

class ParsedRstDocstring(ParsedDocstring):

An encoded version of a ReStructuredText docstring. The contents of the docstring are encoded in the _document instance variable.

Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Method	`to_node`	Translate this docstring to a `docutils.nodes.document`.
Property	`has_body`	Does this docstring have a non-empty body?
Instance Variable	`_document`	A ReStructuredText document, encoding the docstring.

Inherited from ParsedDocstring:

Method	`to_stan`	Translate this docstring to a Stan tree.
Instance Variable	`fields`	A list of `Field`s, each of which encodes a single field. The field's bodies are encoded as `ParsedDocstring`s.
Instance Variable	`_stan`	Undocumented

def __init__(self, document, fields):

overrides pydoctor.epydoc.markup.ParsedDocstring.__init__

overridden in pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr

Undocumented

def __repr__(self):

Undocumented

Returns
`str`	Undocumented

def to_node(self):

overrides pydoctor.epydoc.markup.ParsedDocstring.to_node

Translate this docstring to a docutils.nodes.document.

Returns
`nodes.document`	The docstring presented as a `docutils.nodes.document`.

@property
has_body: bool =

overrides pydoctor.epydoc.markup.ParsedDocstring.has_body

Does this docstring have a non-empty body?

The body is the part of the docstring that remains after the fields have been split off.

_document =

A ReStructuredText document, encoding the docstring.