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): (source)

Return the text inside the node(s).

Parameters
node:Union[nodes.Node, List[nodes.Node]]Undocumented
Returns
List[str]Undocumented
def node2html(node, docstring_linker, compact=True): (source)

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

Parameters
node:nodes.NodeUndocumented
docstring_linker:DocstringLinkerUndocumented
compact:boolUndocumented
Returns
List[str]Undocumented
def node2stan(node, docstring_linker, compact=True): (source)

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

Parameters
node:Union[nodes.Node, Iterable[nodes.Node]]An docutils document or a fragment of document.
docstring_linker:DocstringLinkerUndocumented
compact:boolUndocumented
Returns
TagThe 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): (source)

Remove invalid characters to create valid CSS identifiers.

Parameters
s:strUndocumented
Returns
strUndocumented
_TARGET_RE = (source)

Undocumented

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

Undocumented

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