all2md.renderers.docx

DOCX rendering from AST.

This module provides the DocxRenderer class which converts AST nodes to Microsoft Word (.docx) format. The renderer uses the python-docx library to generate properly formatted Word documents.

The rendering process uses the visitor pattern to traverse the AST and generate DOCX content with appropriate styles and formatting.

class all2md.renderers.docx.DocxRenderer

Bases: NodeVisitor, BaseRenderer

Render AST nodes to DOCX format.

This class implements the visitor pattern to traverse an AST and generate a Microsoft Word document. It uses python-docx for document generation and supports most common formatting features.

Parameters:: options (DocxRendererOptions or None, default = None) – DOCX formatting options

Examples

Basic usage:

>>> from all2md.ast import Document, Heading, Text
>>> from all2md.options import DocxRendererOptions
>>> from all2md.renderers.docx import DocxRenderer
>>> doc = Document(children=[
...     Heading(level=1, content=[Text(content="Title")])
... ])
>>> options = DocxRendererOptions()
>>> renderer = DocxRenderer(options)
>>> renderer.render(doc, "output.docx")

Initialize the DOCX renderer with options.

__init__(options: DocxRendererOptions | None = None): Initialize the DOCX renderer with options.

render(doc: Document, output: str | Path | IO[bytes]) → None

Render the AST to a DOCX file.

Parameters:

doc (Document) – AST Document node to render
output (str, Path, or IO[bytes]) – Output destination (file path or file-like object)

Raises:

RenderingError – If DOCX generation fails

render_to_bytes(doc: Document) → bytes

Render the AST to DOCX bytes.

Parameters:: doc (Document) – AST Document node to render
Returns:: DOCX file content as bytes
Return type:: bytes
Raises:: RenderingError – If DOCX generation fails

visit_document(node: Document) → None

Render a Document node.

Parameters:: node (Document) – Document to render

visit_heading(node: Heading) → None

Render a Heading node.

Parameters:: node (Heading) – Heading to render

visit_paragraph(node: Paragraph) → None

Render a Paragraph node.

Parameters:: node (Paragraph) – Paragraph to render

visit_code_block(node: CodeBlock) → None

Render a CodeBlock node.

Parameters:: node (CodeBlock) – Code block to render

visit_block_quote(node: BlockQuote) → None

Render a BlockQuote node.

Parameters:: node (BlockQuote) – Block quote to render

visit_list(node: List) → None

Render a List node.

Parameters:: node (List) – List to render

visit_list_item(node: ListItem) → None

Render a ListItem node.

Parameters:: node (ListItem) – List item to render

visit_table(node: Table) → None

Render a Table node.

Parameters:: node (Table) – Table to render

visit_table_row(node: TableRow) → None

Render a TableRow node.

Parameters:: node (TableRow) – Table row to render

visit_table_cell(node: TableCell) → None

Render a TableCell node.

Parameters:: node (TableCell) – Table cell to render

visit_thematic_break(node: ThematicBreak) → None

Render a ThematicBreak node.

Parameters:: node (ThematicBreak) – Thematic break to render

visit_html_block(node: HTMLBlock) → None

Render an HTMLBlock node.

Parameters:: node (HTMLBlock) – HTML block to render

visit_text(node: Text) → None

Render a Text node.

Parameters:: node (Text) – Text to render

visit_emphasis(node: Emphasis) → None

Render an Emphasis node.

Parameters:: node (Emphasis) – Emphasis to render

visit_strong(node: Strong) → None

Render a Strong node.

Parameters:: node (Strong) – Strong to render

visit_code(node: Code) → None

Render a Code node.

Parameters:: node (Code) – Code to render

visit_link(node: Link) → None

Render a Link node.

Parameters:: node (Link) – Link to render

visit_image(node: Image) → None

Render an Image node.

Parameters:: node (Image) – Image to render

visit_line_break(node: LineBreak) → None

Render a LineBreak node.

Parameters:: node (LineBreak) – Line break to render

visit_strikethrough(node: Strikethrough) → None

Render a Strikethrough node.

Parameters:: node (Strikethrough) – Strikethrough to render

visit_underline(node: Underline) → None

Render an Underline node.

Parameters:: node (Underline) – Underline to render

visit_superscript(node: Superscript) → None

Render a Superscript node.

Parameters:: node (Superscript) – Superscript to render

visit_subscript(node: Subscript) → None

Render a Subscript node.

Parameters:: node (Subscript) – Subscript to render

visit_html_inline(node: HTMLInline) → None

Render an HTMLInline node.

Parameters:: node (HTMLInline) – Inline HTML to render

visit_footnote_reference(node: FootnoteReference) → None

Render a FootnoteReference node.

Parameters:: node (FootnoteReference) – Footnote reference to render

visit_math_inline(node: MathInline) → None

Render a MathInline node.

Parameters:: node (MathInline) – Inline math to render

visit_footnote_definition(node: FootnoteDefinition) → None

Render a FootnoteDefinition node.

Parameters:: node (FootnoteDefinition) – Footnote definition to render

visit_definition_list(node: DefinitionList) → None

Render a DefinitionList node.

Parameters:: node (DefinitionList) – Definition list to render

visit_definition_term(node: DefinitionTerm) → None

Render a DefinitionTerm node.

Parameters:: node (DefinitionTerm) – Definition term to render

visit_definition_description(node: DefinitionDescription) → None

Render a DefinitionDescription node.

Parameters:: node (DefinitionDescription) – Definition description to render