pydoctor.epydoc.markup.ParsedDocstring

class documentation

class ParsedDocstring(abc.ABC): (source)

Known subclasses: pydoctor.epydoc.markup._types.ParsedTypeDocstring, pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring, pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring, pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring, pydoctor.epydoc2stan.ParsedStanOnly

View In Hierarchy

A standard intermediate representation for parsed docstrings that can be used to generate output. Parsed docstrings are produced by markup parsers such as pydoctor.epydoc.markup.epytext.parse_docstring() or pydoctor.epydoc.markup.restructuredtext.parse_docstring().

Subclasses must implement has_body() and to_node().

A default implementation for to_stan() method, relying on to_node() is provided. But some subclasses override this behaviour.

Implementation of get_toc() also relies on to_node().

Method	`__init__`	Undocumented
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_node`	Translate this docstring to a `nodes.document`.
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.
Property	`has_body`	Does this docstring have a non-empty body?
Instance Variable	`_compact`	Undocumented
Instance Variable	`_stan`	Undocumented
Instance Variable	`_summary`	Undocumented

def __init__(self, fields): (source) ¶

overridden in pydoctor.epydoc.markup._types.ParsedTypeDocstring, pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring, pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring, pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring, pydoctor.epydoc2stan.ParsedStanOnly

Undocumented

Parameters
fields:`Sequence[Field]`	Undocumented

def get_summary(self): (source) ¶

Returns the summary of this docstring.

Returns
`ParsedDocstring`	Undocumented
Note
The summary is cached.

def get_toc(self, depth): (source) ¶

The table of contents of the docstring if titles are defined or None.

Parameters
depth:`int`	Undocumented
Returns
`Optional[ParsedDocstring]`	Undocumented

@abc.abstractmethod
def to_node(self): (source) ¶

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, compact=True): (source) ¶

overridden in pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr, pydoctor.epydoc.markup._types.ParsedTypeDocstring, pydoctor.epydoc.markup.plaintext.ParsedPlaintextDocstring, pydoctor.epydoc2stan.ParsedStanOnly

Translate this docstring to a Stan tree.

Parameters
docstring_linker:`DocstringLinker`	An HTML translator for crossreference links into and out of the docstring.
compact:`bool`	Undocumented
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()`.

fields = (source) ¶

A list of Fields, each of which encodes a single field. The field's bodies are encoded as ParsedDocstrings.

@abc.abstractproperty
has_body: bool = (source) ¶

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.

_compact = (source) ¶

Undocumented

_stan = (source) ¶

overridden in pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring

Undocumented

_summary: Optional[ParsedDocstring] = (source) ¶

Undocumented