pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring

class documentation

class ParsedRstDocstring(ParsedDocstring): (source)

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 `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	`get_summary`	Returns the summary of this docstring.
Method	`get_toc`	The table of contents of the docstring if titles are defined or `None`.
Method	`to_stan`	Translate this docstring to a Stan tree.
Method	`to_text`	Translate this docstring to a string. The default implementation depends on `to_node`.
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: nodes.document, fields: Sequence[Field]): (source) ¶

overrides pydoctor.epydoc.markup.ParsedDocstring.__init__

overridden in pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr

Undocumented

def __repr__(self) -> str: (source) ¶

Undocumented

def to_node(self) -> nodes.document: (source) ¶

overrides pydoctor.epydoc.markup.ParsedDocstring.to_node

Translate this docstring to a nodes.document.

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

Note
Some `ParsedDocstring` subclasses do not support docutils nodes. This method might raise `NotImplementedError` in such cases. (i.e. `pydoctor.epydoc.markup._types.ParsedTypeDocstring`)

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.

A ReStructuredText document, encoding the docstring.