Skip to main content

Module nodes

Module nodes 

Source
Expand description

Document tree model: mirrors docutils.nodes element names so the full port maps 1:1. Inline content first, then block elements, then Document.

Structs§

Admonition
BlockQuote
BulletList
Citation
CitationRef
Citation reference: [CIT]_.
Container
DefItem
Document
Parsed document: section tree plus collected metadata.
EnumList
Field
Figure
Footnote
FootnoteRef
Footnote reference: [1]_, [#name]_, [#]_, [*]_.
HyperlinkTarget
Image
LiteralBlock
OptGroup
OptName
PendingRef
Parser-level reference before target resolution.
Problematic
Unresolvable inline content (mirrors docutils.nodes.problematic).
Raw
Section
SubstitutionDef
SubstitutionRef
Substitution reference: |name|.
SystemMessage
Table
TableCell
Topic

Enums§

AdmonKind
Block
Block-level elements.
EnumFormat
Inline
Inline (sub-block) content.
LineRow
One row of a line block: a line, or a nested line block (an extra-indented | run, per the oracle).
RefTarget
Resolved link target.

Functions§

block_text
Plain-text rendering of a block (for astext parity checks).
inline_text
Plain-text rendering of inline content (for titles, ids, astext).
slugify
Lowercase, map whitespace/runs of non-alphanumeric to -, trim -. Mirrors docutils.nodes.fully_normalize_name closely enough for ids.