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
- Block
Quote - Bullet
List - Citation
- Citation
Ref - Citation reference:
[CIT]_. - Container
- DefItem
- Document
- Parsed document: section tree plus collected metadata.
- Enum
List - Field
- Figure
- Footnote
- Footnote
Ref - Footnote reference:
[1]_,[#name]_,[#]_,[*]_. - Hyperlink
Target - Image
- Literal
Block - OptGroup
- OptName
- Pending
Ref - Parser-level reference before target resolution.
- Problematic
- Unresolvable inline content (mirrors
docutils.nodes.problematic). - Raw
- Section
- Substitution
Def - Substitution
Ref - Substitution reference:
|name|. - System
Message - Table
- Table
Cell - Topic
Enums§
- Admon
Kind - Block
- Block-level elements.
- Enum
Format - 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
astextparity checks). - inline_
text - Plain-text rendering of inline content (for titles, ids,
astext). - slugify
- Lowercase, map whitespace/runs of non-alphanumeric to
-, trim-. Mirrorsdocutils.nodes.fully_normalize_nameclosely enough for ids.