Publishing#

Document rendering for regulatory submissions.

HTML Renderer#

jamb.publish.formats.html.render_html(items, title, include_links=True, document_order=None, graph=None)[source]#

Render items as a standalone HTML document.

Parameters:

  • items (list[Item]) – List of Item objects to include.

  • title (str) – The document title.

  • include_links (bool) – Whether to include parent and child link sections.

  • document_order (list[str] | None) – Optional list of document prefixes in hierarchy order.

  • graph (TraceabilityGraph | None) – Optional traceability graph for child link lookup.

Returns:

str – HTML string.

Return type:

str

DOCX Renderer#

jamb.publish.formats.docx.render_docx(items, title, include_links=True, document_order=None, graph=None, template_path=None)[source]#

Render items as a Word document.

Parameters:

  • items (list[Item]) – List of Item objects to include in the document.

  • title (str) – The document title.

  • include_links (bool) – Whether to include links section for each item.

  • document_order (list[str] | None) – Optional list of document prefixes in hierarchy order (root first, then children). If None, sorts alphabetically.

  • graph (TraceabilityGraph | None) – Optional traceability graph for child link lookup.

  • template_path (str | None) – Optional path to a DOCX template file to use as base.

Returns:

bytes – Bytes representing the DOCX file.

Return type:

bytes