pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr

class documentation

class ColorizedPyvalRepr(ParsedRstDocstring): (source)

Method	`__init__`	Undocumented
Method	`to_stan`	Translate this docstring to a Stan tree.
Instance Variable	`is_complete`	True if this colorized repr completely describes the object.
Instance Variable	`warnings`	List of warnings

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.

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_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, is_complete: bool, warnings: list[str]): (source) ¶

overrides pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring.__init__

Undocumented

def to_stan(self, docstring_linker: DocstringLinker) -> Tag: (source) ¶

overrides pydoctor.epydoc.markup.ParsedDocstring.to_stan

Translate this docstring to a Stan tree.

Parameters
docstring_linker:`DocstringLinker`	An HTML translator for crossreference links into and out of the docstring.

Returns
`Tag`	The docstring presented as a stan tree.

Raises
`Exception`	If something went wrong. Callers should generally catch `Exception` when calling `to_stan()`.

Note
The default implementation relies on functionalities provided by `node2stan.node2stan` and `ParsedDocstring.to_node()`.

True if this colorized repr completely describes the object.

List of warnings