Skip to content

v0.10.0

Choose a tag to compare

@github-actions github-actions released this 01 Jun 05:14
· 13 commits to main since this release

v0.10.0

Highlights

  • Simplified the user-facing Document API so document metadata, page geometry, page overlays, units, and renderer theme options all live under DocumentSettings.
  • Updated renderers, examples, and documentation to use document.settings.theme, document.settings.cover_page, document.settings.subtitle, and related settings fields internally and in public examples.
  • Moved page-positioned overlays to DocumentSettings(page_items=[...]), keeping Document(...) focused on title, body content, citations, validation, and rendering.
  • Renamed the simple file-property author setting to metadata_author so it is distinct from structured visible authors.
  • Added document validation and source validation workflows, including structured compatibility results that can be printed as readable tables.
  • Added CLI entry points for build, convert, and validate workflows.
  • Added theorem-like countable blocks such as Definition, Lemma, Theorem, Proof, Example, Remark, and Assumption, plus a countable_kind(...) helper for custom counters.
  • Added Markdown heading-level controls and a release-note digest example that imports versioned Markdown files into a generated document.
  • Expanded the usage guide and example documents with generated bitmap diagrams and refreshed rendered examples.

Compatibility Notes

  • Removed direct Document proxies for settings values such as document.author, document.summary, document.subtitle, document.authors, document.cover_page, document.unit, document.theme, and document-level geometry helpers.
  • Removed the Document(..., page_items=[...]) constructor shortcut. Use Document(..., settings=DocumentSettings(page_items=[...])) instead.
  • Renamed DocumentSettings(author=...) to DocumentSettings(metadata_author=...).
  • This is a minor release because backward compatibility is not preserved.

Renderer Notes

  • Table cells now default to left-aligned text across DOCX, PDF, and HTML so narrow cells do not inherit document-level justified paragraph spacing.
  • PDF, DOCX, and HTML rendering now handle more reference targets, caption/reference label customization, slight table, code, and highlight spacing, inline chips, vertical spacing, and footnote indexing more consistently across output formats.

Dependencies

  • Added Pillow as a runtime dependency for inline chip rendering.
  • Added Pygments as a runtime dependency for syntax highlighting.