Module

directives.builtins.container

Container directive for generic wrapper divs.

Provides a generic wrapper div with custom CSS classes. Similar to Sphinx/MyST container directive.

Use cases:

  • Wrapping content with semantic styling
  • Creating styled blocks without affecting heading hierarchy
  • Grouping related content with a common class

Example:

Content here

Thread Safety:

Stateless handler. Safe for concurrent use across threads.

2Classes

Classes

ContainerOptions 0 ▼
Options for container directive. The :class: option adds additional CSS classes beyond those speci…

Options for container directive.

The :class: option adds additional CSS classes beyond those specified in the title.

ContainerDirective 7 ▼
Handler for container directive. Renders a generic wrapper div with custom CSS classes. The title …

Handler for container directive.

Renders a generic wrapper div with custom CSS classes. The title line is treated as class names.

Thread Safety:

Stateless handler. Safe for concurrent use.

Attributes

Name Type Description
names ClassVar[tuple[str, ...]] —
token_type ClassVar[str] —
contract ClassVar[DirectiveContract | None] —
options_class ClassVar[type[ContainerOptions]] —
preserves_raw_content ClassVar[bool] —

Methods

parse 6 Directive ▼
Build container AST node. The title is treated as class name(s). Additional cl…
def parse(self, name: str, title: str | None, options: ContainerOptions, content: str, children: Sequence[Block], location: SourceLocation) -> Directive

Build container AST node.

The title is treated as class name(s). Additional classes from :class: option are merged.

Parameters
Name Type Description
name —
title —
options —
content —
children —
location —
Returns
Directive
render 3 ▼
Render container to HTML. Produces a div with the specified classes.
def render(self, node: Directive[ContainerOptions], rendered_children: str, sb: StringBuilder) -> None
Parameters
Name Type Description
node —
rendered_children —
sb —