module documentation
Helper function to convert docutils
nodes to Stan tree.
Class |
|
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 |
Remove invalid characters to create valid CSS identifiers. |
Constant | _TARGET |
Undocumented |
Constant | _VALID |
Undocumented |
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[ | An docutils document or a fragment of document. |
docstringDocstringLinker | 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. |