pydoctor.epydoc.docutils

module documentation

(source)

Collection of helper functions and classes related to the creation and processing of docutils nodes.

Class	`code`	Like a inline[class='literal'], but more elegant.
Class	`obj_reference`	A reference to a documentable object.
Class	`wbr`	Word break opportunity.
Function	`build_table_of_content`	Simplified from docutils Contents transform.
Function	`get_lineno`	Get the 0-based line number for a docutils `nodes.title_reference`.
Function	`new_document`	Create a new `nodes.document` using the provided settings or cached default settings.
Function	`set_node_attributes`	Set the attributes of a Node and return the modified node. This is required to manually construct a docutils document that is consistent.
Function	`text_node`	Create an inline node with the given text and class.
Type Variable	`TNode`	Undocumented
Function	`_set_nodes_parent`	Set the `nodes.Node.parent` attribute of the `nodes` to the defined `parent`.
Constant	`_DEFAULT_DOCUTILS_SETTINGS`	Undocumented

def build_table_of_content(node: nodes.Element, depth: int, level: int = 0) -> nodes.Element | None: (source) ¶

Simplified from docutils Contents transform.

All section nodes MUST have set attribute 'ids' to a list of strings.

def get_lineno(node: nodes.Element) -> int: (source) ¶

Get the 0-based line number for a docutils `nodes.title_reference`.

Walk up the tree hierarchy until we find an element with a line number, then counts the number of newlines until the reference element is found.

def new_document(source: Literal['docstring', 'code'], settings: optparse.Values | None = None) -> nodes.document: (source) ¶

Create a new nodes.document using the provided settings or cached default settings.

Returns
`nodes.document`	`nodes.document` with a `source` attribute that matches the provided source.

def set_node_attributes(node: TNode, document: nodes.document | None = None, lineno: int | None = None, children: Iterable[nodes.Node] | None = None) -> TNode: (source) ¶

Set the attributes of a Node and return the modified node. This is required to manually construct a docutils document that is consistent.

Parameters
node:`TNode`	A node to edit.
document:`nodes.document \| None`	The `nodes.Node.document` attribute.
lineno:`int \| None`	The `nodes.Node.line` attribute.
children:`Iterable[nodes.Node] \| None`	The `nodes.Element.children` attribute. Special care is taken to appropriately set the `nodes.Node.parent` attribute on the child nodes.

Returns
`TNode`	Undocumented

def text_node(text: str, klass: str | None = None) -> nodes.inline: (source) ¶

Create an inline node with the given text and class.

Undocumented

Value

TypeVar('TNode',
        bound=nodes.Node)

def _set_nodes_parent(nodes: Iterable[nodes.Node], parent: nodes.Element) -> Iterator[nodes.Node]: (source) ¶

Set the nodes.Node.parent attribute of the nodes to the defined parent.

Returns
`Iterator[nodes.Node]`	An iterator containing the modified nodes.

_DEFAULT_DOCUTILS_SETTINGS: optparse.Values | None = (source) ¶

Undocumented

Value

None