pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring

class documentation

class ParsedPlaintextDocstring(ParsedDocstring): (source)

Undocumented

Method	`__init__`	Undocumented
Method	`to_node`	Translate this docstring to a `nodes.document`.
Method	`to_stan`	Translate this docstring to a Stan tree.
Property	`has_body`	Does this docstring have a non-empty body?
Instance Variable	`_document`	Undocumented
Instance Variable	`_text`	Undocumented

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_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, text: str): (source) ¶

overrides pydoctor.epydoc.markup.ParsedDocstring.__init__

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`)

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()`.

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: nodes.document | None = (source) ¶

Undocumented

Undocumented