Nodes
Table of Contents
Namespaces
- Configuration
- DefinitionLists
- DocumentTree
- FieldLists
- Index
- Inline
- Links
- Lists
- Menu
- Metadata
- Table
Interfaces
- ConsumesDefaultHighlightLanguage
- Implement this interface on a Node to let the compiler set the default highlight
language on it, as configured by the project settings or the reStructuredText
`.. highlight::` directive, whenever the node does not already have an explicit
language set.
- Language
- What a language tag looks like, for everything that accepts one.
- LinkTargetNode
- MultipleLinkTargetsNode
- Node
- OptionalLinkTargetsNode
- Makes the implementing node an optional link target. If Noindex is true
no references are generated, there is no entry in the objects index and no
warning about duplicate ids.
- PrefixedLinkTargetNode
Classes
- AbstractNode
- AdmonitionNode
- AnchorNode
- AnnotationListNode
- Defines a list of footnotes or citations
- AnnotationNode
- Defines a footnote or citation
- AuthorNode
- The author element holds the name of the author of a document, section or code-block
- BreadCrumbNode
- CitationNode
- Defines a citation that can be referenced by an CitationInlineNode
- ClassNode
- CodeNode
- CollectionNode
- A collection node is a node that renders all its children without adding
a wrap. It is used by directives, that change sub-nodes without
having an output of their own, like the class-directive.
- CompoundNode
- DataNode
- A named piece of data attached to another node, rendered as an HTML
`data-*` attribute on it.
- DefinitionListNode
- DocumentBlockNode
- DocumentNode
- EmbeddedFrame
- FieldListNode
- FigureNode
- FootnoteNode
- Defines a footnote that can be referenced by an FootnoteInlineNode
- GenericNode
- Any Directive not explicitly modeled.
- HighlightNode
- Marker node to set the default code language.
- ImageNode
- IncludedContentNode
- Contains nodes inserted into a document by an include directive.
- InlineCompoundNode
- ListItemNode
- Represents a single item of a bullet or enumerated list.
- ListNode
- LiteralBlockNode
- MainNode
- MathNode
- ParagraphNode
- ProjectNode
- QuoteNode
- RawNode
- ReplacementNode
- SectionNode
- SeparatorNode
- SpanNode
- TableNode
- The cells of the header rows and then of the data rows are the children of
the table, so that the compiler processes their content, such as the
directives that are created at compile time.
- TextNode
- TitleNode
Enums
- TextDirection
- The direction a piece of text is read in, as the HTML "dir" attribute spells it.