pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring

class documentation

class ParsedEpytextDocstring(ParsedDocstring): (source)

Undocumented

Method	`__init__`	Undocumented
Method	`__str__`	Undocumented
Method	`to_node`	Translate this docstring to a `nodes.document`.
Constant	`SYMBOL_TO_CODEPOINT`	Undocumented
Property	`has_body`	Does this docstring have a non-empty body?
Method	`_slugify`	Undocumented
Method	`_to_node`	Undocumented
Instance Variable	`_document`	Undocumented
Instance Variable	`_section_slugs`	Undocumented
Instance Variable	`_stan`	Undocumented
Instance Variable	`_tree`	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_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.

def __init__(self, body: Element | None, fields: Sequence[Field]): (source) ¶

overrides pydoctor.epydoc.markup.ParsedDocstring.__init__

Undocumented

def __str__(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`)

SYMBOL_TO_CODEPOINT: dict[str, int] = (source) ¶

Undocumented

Value

{'<-': 8592,
 '->': 8594,
 '^': 8593,
 'v': 8595,
 'alpha': 945,
 'beta': 946,
 'gamma': 947,
...

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.

def _slugify(self, text: str) -> str: (source) ¶

Undocumented

def _to_node(self, tree: Element) -> Iterable[nodes.Node]: (source) ¶

Undocumented

_document: nodes.document | None = (source) ¶

Undocumented

Undocumented

overrides pydoctor.epydoc.markup.ParsedDocstring._stan

Undocumented

Undocumented