pydoctor.node2stan

module documentation

(source)

Helper function to convert docutils nodes to Stan tree.

Class	`HTMLTranslator`	Pydoctor's HTML translator.
Function	`gettext`	Return the text inside the node(s).
Function	`node2html`	Convert a `docutils.nodes.Node` object to HTML strings.
Function	`node2stan`	Convert `docutils.nodes.Node` objects to a Stan tree.
Function	`_valid_identifier`	Remove invalid characters to create valid CSS identifiers.
Constant	`_TARGET_RE`	Undocumented
Constant	`_VALID_IDENTIFIER_RE`	Undocumented

def gettext(node: nodes.Node | list[nodes.Node]) -> list[str]: (source) ¶

Return the text inside the node(s).

def node2html(node: nodes.Node, docstring_linker: DocstringLinker) -> list[str]: (source) ¶

Convert a docutils.nodes.Node object to HTML strings.

def node2stan(node: nodes.Node | Iterable[nodes.Node], docstring_linker: DocstringLinker) -> Tag: (source) ¶

Convert docutils.nodes.Node objects to a Stan tree.

Parameters
node:`nodes.Node \| Iterable[nodes.Node]`	An docutils document or a fragment of document.
docstring_linker:`DocstringLinker`	Undocumented

Returns
`Tag`	The element as a stan tree.

Note
Any `nodes.Node` can be passed to that function, the only requirement is that the node's `nodes.Node.document` attribute is set to a valid `nodes.document` object.

def _valid_identifier(s: str) -> str: (source) ¶

Remove invalid characters to create valid CSS identifiers.

Undocumented

Value

re.compile(r'^(.*?)\s*<(?:URI:|L:)?([^<>]+)>$')

Undocumented

Value

re.compile(r'[^0-9a-zA-Z_]')