Release v0.4.3

Changes since v0.4.2

• Merge pull request #83 from YuSabo90002/release/v0.4.3 (415498a)
• Merge branch 'main' into release/v0.4.3 (6f8ed1b)
• chore: bump version to 0.4.3 (a9a5f17)
• Merge pull request #82 from YuSabo90002/update/remove-beta-status (764bc0c)
• chore: promote project to stable release and update author info (0043fae)
• Merge pull request #81 from YuSabo90002/openspec/impl-add-template-assets (0da8179)
• style: fix black formatting in test_template_assets.py (0021f4c)
• feat: add automatic template asset copying support (10100b9)
• Merge pull request #80 from YuSabo90002/openspec/impl-fix-empty-url-links (e87e852)
• fix: handle empty URL references for Typst 0.14.1+ compatibility (abea0fb)
• Merge pull request #79 from YuSabo90002/openspec/proposal-fix-empty-url-links (f97f785)
• Merge branch 'main' into openspec/proposal-fix-empty-url-links (0ff57f9)
• docs: add OpenSpec proposal to fix empty URL link generation (be0af65)
• Merge pull request #78 from YuSabo90002/openspec/proposal-add-template-assets (4929dd0)
• docs: add OpenSpec proposal for template asset support (fb766fe)
• Merge pull request #76 from YuSabo90002/upgrade/openspec-0.13.0 (0a5c3d3)
• chore: upgrade OpenSpec to v0.13.0 (c722018)

Installation

pip install typsphinx==0.4.3

Release v0.4.2

Changes since v0.4.1

• Merge pull request #74 from YuSabo90002/release/v0.4.2 (445af8c)
• chore: prepare release v0.4.2 (81f2b43)
• Merge pull request #73 from YuSabo90002/openspec/archive-fix-nested-image-paths (24967cd)
• docs: archive fix-nested-image-paths OpenSpec change (bbac560)
• Merge pull request #72 from YuSabo90002/issue/69-image-relative-paths (dffa86f)
• Merge branch 'main' into issue/69-image-relative-paths (fef257e)
• fix: adjust image paths for nested documents (Issue #69) (9bb0045)
• Merge pull request #71 from YuSabo90002/openspec/archive-fix-empty-table-cells (aa3c82a)
• docs: archive fix-empty-table-cells OpenSpec change (f88ab47)
• Merge pull request #70 from YuSabo90002/openspec/fix-empty-table-cells (1368800)
• fix: wrap table cells in content blocks to fix empty cell errors (0e3a168)
• docs: add mypy type checking to quality assurance tasks (6320cea)
• docs: fix tasks.md format for OpenSpec checkbox detection (5e81769)
• docs: add Why section to OpenSpec proposal (d7d2aeb)
• docs: enhance OpenSpec proposal with colspan/rowspan empty cell scenarios (9435a0e)
• docs: add OpenSpec proposal for fixing empty table cells (962a3d0)

Installation

pip install typsphinx==0.4.2

Release v0.4.1

Changes since v0.4.0

• Merge pull request #67 from YuSabo90002/release/v0.4.1 (0ed33d1)
• chore: bump version to 0.4.1 (2286ad6)
• Merge pull request #66 from YuSabo90002/openspec/archive-fix-table-cell-unified-code-mode (4307a3d)
• docs: archive OpenSpec change fix-table-cell-unified-code-mode (14579c0)
• Merge pull request #65 from YuSabo90002/fix/table-cell-unified-code-mode (e0cf27e)
• fix: table cells use content type directly without markup mode (dec39f1)

Installation

pip install typsphinx==0.4.1

Release v0.4.0

Changes since v0.3.0

• Merge pull request #64 from YuSabo90002/release/v0.4.0 (08aeb4b)
• ci: add PDF to GitHub Pages deployment (5c3147e)
• docs: fix coverage rate in README (ff5b196)
• docs: update README for v0.4.0 (326b95a)
• chore: bump version to 0.4.0 (9178655)
• chore: add date prefix to archived change (a76cfbe)
• chore: archive OpenSpec change fix-nested-body-stack (776aadf)
• Merge pull request #63 from YuSabo90002/fix/issue-61-saved-body-stack (fa6b902)
• style: fix formatting in translator.py (303929a)
• fix: ensure code mode wrapper for all documents (afd20bf)
• fix: wrap paragraph content in {} block for consistency (737695c)
• refactor: wrap list items in {} blocks for unified code mode (dcccf80)
• fix: add separator logic for reference and literal_block in lists (f9ef787)
• test: add coverage for list item separator logic (283cb6f)
• fix: implement stream-based list rendering (#61) (2ee6168)
• fix: ensure code mode wrapper for all documents (05c0a1c)
• chore: archive OpenSpec change unified-function-approach (90ea6db)
• docs: mark all remaining tasks as completed or deferred (bbea886)
• docs: add required OpenSpec sections to proposal (4fc2066)
• Merge pull request #60 from YuSabo90002/feat/unified-function-approach (7e6082d)
• docs: update tasks.md with final completion status (c87c75d)
• style: format test files with black (23b02d4)
• test: update all tests for unified code mode syntax (b2b48cd)
• docs: mark proposal as implemented (4a45e2d)
• docs: add unified code mode breaking change to CHANGELOG (ae72d36)
• docs: mark Phase 11 and 12.1 as completed in tasks.md (f868fdd)
• style: fix formatting and type annotations (1532780)
• docs: mark completed tasks in unified-function-approach (695d6f5)
• feat: complete unified code mode implementation (5676388)
• feat: implement list(), enum(), and terms() functions (22fb26c)
• fix: handle list items and code blocks in unified code mode (cef18c2)
• feat: remove # prefix from all function calls (1079624)
• feat: implement Phase 0-3 of unified code mode (0dc9a22)
• Merge pull request #59 from YuSabo90002/proposal/unified-function-approach (86caf08)
• proposal: update tasks.md to reflect current specification (2c01117)
• proposal: add import zone specification (fed12c9)
• proposal: use {...} scope block for toctree instead of #[...] (7baa599)
• proposal: fix toctree to keep nested content block for scope (8ee4725)
• proposal: fix code block syntax from #[...] to #{...} (47eb1c9)
• proposal: add toctree include() specification (7674d9e)
• proposal: fix strong/emph to use text() instead of markup mode (1e24cf5)
• proposal: fix backtick delimiter requirement to minimum 3 (90de9d3)
• proposal: use backtick raw strings for raw() function (a80ee3b)
• proposal: correct raw() to use string parameters, not backticks (567bb53)
• proposal: use backtick raw strings for raw() function (2812dc6)
• proposal: distinguish inline math (mi) vs block math (mitex) (3cea98e)
• proposal: use backtick raw strings for math mi() function (245efb3)
• proposal: add complete Typst string escape sequence list (0bd5d30)
• proposal: add escape sequence requirements for text() function (8b70a53)
• proposal: add par() function requirement for paragraphs (f6a4739)
• proposal: convert definition lists to terms.item() function (71b27f1)
• proposal: convert code blocks to raw() function for codly compatibility (7f57e58)
• proposal: use text() function instead of [...] markup mode (89802ff)
• proposal: update to code mode approach per Issue #4 comment (7933d5c)
• proposal: unified function approach for all Typst elements (6ac7323)
• Merge pull request #57 from YuSabo90002/chore/archive-add-autodoc-node-support (71f9f81)
• chore: archive OpenSpec change add-autodoc-node-support (aa34302)
• Merge pull request #56 from YuSabo90002/feat/add-autodoc-node-support (21154eb)
• feat: add support for API description nodes (autodoc) (5f085ff)
• Merge pull request #54 from YuSabo90002/chore/archive-migrate-ci-to-tox (15a2c3a)
• chore: archive OpenSpec change migrate-ci-to-tox (488a94e)
• fix: change MODIFIED to ADDED for CI/CD requirement in migrate-ci-to-tox spec (59f5afb)
• Merge pull request #53 from YuSabo90002/refactor/migrate-ci-to-tox (4e4b286)
• refactor: migrate CI to tox (063a2be)
• Merge pull request #52 from YuSabo90002/chore/archive-add-documentation-site (0c8f84c)
• docs: archive OpenSpec change add-documentation-site (0260e38)
• Merge pull request #51 from YuSabo90002/feature/add-documentation-site (a1ad111)
• style: fix import order in docs/source/conf.py (2796628)
• feat: auto-sync version from pyproject.toml in documentation (0374f49)
• docs: update version to 0.3.0 in documentation (13e2f16)
• feat: add comprehensive documentation site with GitHub Pages (691030d)
• Merge pull request #50 from YuSabo90002/chore/archive-add-typst-universe-template-support (0bc621e)
• docs: archive OpenSpec change add-typst-universe-template-support (c31a238)
• Merge pull request #49 from YuSabo90002/feature/typst-universe-templates (361f1ca)
• style: fix formatting and remove unused imports in examples (e266bf6)
• feat: add Typst Universe template support (Issue #13) (dd225a9)
• Merge branch 'main' into feature/typst-universe-templates (01f64df)
• Merge pull request #48 from YuSabo90002/chore/archive-copy-image-files (0389fd0)
• docs: archive OpenSpec change copy-image-files (5e4b6d1)
• Merge pull request #47 from YuSabo90002/feature/issue-38-image-copying (9b8f140)
• Merge branch 'main' into feature/issue-38-image-copying (7ea2de0)
• docs: update CHANGELOG and mark all tasks complete (a5c85c7)
• feat: add image copying to output directory (#38) (d0a16ce)
• Merge pull request #46 from YuSabo90002/docs/update-changelog-table-features (307aa57)
• Merge branch 'main' into docs/update-changelog-table-features (cbf9bd0)
• Merge pull request #45 from YuSabo90002/chore/archive-support-cell-spanning (85e0075)
• docs: update CHANGELOG with table features (#39, #40) (35f7e95)
• chore: archive OpenSpec change support-cell-spanning (86c0337)
• Merge pull request #44 from YuSabo90002/feature/issue-39-cell-spanning (cd6646e)
• feat: support table cell spanning (colspan/rowspan) (27522c8)
• Merge pull request #43 from YuSabo90002/chore/archive-wrap-table-headers (908a17f)
• chore: archive OpenSpec change wrap-table-headers (d0151b3)
• Merge pull request #42 from YuSabo90002/chore/update-openspec-instructions (fc0e844)
• Merge branch 'main' into chore/update-openspec-instructions (14d4dfb)
• Merge pull request #41 from YuSabo90002/feature/issue-40-openspec (e25c4fa)
• Merge branch 'main' into chore/update-openspec-instructions (608c396)
• Merge branch 'main' into feature/issue-40-openspec (5a211a1)
• chore: update OpenSpec instruction files (00eaf29)
• feat: wrap table headers in table.header() for proper rendering (c0c234e)
• Merge pull request #37 from YuSabo90002/docs/translate-changelog-v0.3.0 (2649edd)
• docs: translate v0.3.0 section in CHANGELOG to English (316252f)
• docs: add documentation structure reorganization to tasks (fe349bf)
• docs: add detailed file changes for breaking change rename (f465142)
• docs: update OpenSpec proposal with breaking change (aa007e1)
• docs: create OpenSpec proposal for Typst Universe template support (f734a5e)

Installation

pip install typsphinx==0.4.0

Release v0.3.0

Changes since v0.2.2

• docs: archive OpenSpec change rename-package-to-typsphinx (28a80a6)
• Merge pull request #35 from YuSabo90002/refactor/rename-to-typsphinx (588bfda)
• refactor: rename package from sphinxcontrib-typst to typsphinx (56f5bbc)

Installation

pip install typsphinx==0.3.0

What's Changed

• refactor: Rename package from sphinxcontrib-typst to typsphinx (v0.3.0) by @YuSabo90002 in #35

Full Changelog: v0.2.2...v0.3.0

Release v0.2.2

Changes since v0.2.1

• Merge pull request #34 from YuSabo90002/release/v0.2.2 (c1e2db7)
• chore: bump version to 0.2.2 (99e3ecc)
• Merge pull request #33 from YuSabo90002/docs/fix-readme-math-escape (d45e5d0)
• Merge branch 'main' into docs/fix-readme-math-escape (cb6c833)
• docs: fix math directive example in README (5a8b806)
• Merge pull request #32 from YuSabo90002/feature/issue-31-code-block-advanced-options (9b842ec)
• docs: archive OpenSpec change add-code-block-advanced-options (1dd354a)
• docs: mark all tasks as completed in tasks.md (daeccd8)
• feat: add support for :lineno-start: and :dedent: code-block options (716847e)
• Merge pull request #30 from YuSabo90002/fix/issue-20-code-block-options (5d2610c)
• style: fix formatting in test_translator.py (253e6ec)
• docs: archive OpenSpec change fix-code-block-options (54d3424)
• chore: merge main branch and resolve conflicts (0cd5ced)
• Merge pull request #29 from YuSabo90002/fix/issue-28-codly-import (fdab0dd)
• docs: archive OpenSpec change fix-codly-import (d575481)
• docs: update OpenSpec tasks and spec for archiving (635006c)
• chore: merge main branch and resolve CHANGELOG.md conflict (0fcbf42)
• docs: update tasks.md - mark code modification as completed (84fba99)
• fix: add codly imports to document-level essential imports (87efd97)
• docs: add OpenSpec proposal for fix-codly-import (Issue #28) (77724b4)
• fix: support code block directive options (:linenos:, :caption:, :name:) (cfe10d7)
• docs: fix figure syntax in spec.md to use trailing content block (3a80ce3)
• docs: add OpenSpec proposal for code block options support (c2d8c8a)
• Merge pull request #27 from YuSabo90002/feature/add-raw-typst-directive (a14441c)
• style: fix import order in test_translator.py (d458e4d)
• docs: archive OpenSpec change add-raw-typst-directive (402c50d)
• docs: update tasks.md with completed implementation steps (d107a32)
• feat: add support for raw typst directive (fixes #25) (0133f1d)
• docs: add OpenSpec proposal for raw typst directive support (19b5415)
• Merge pull request #26 from YuSabo90002/add-mit-license (939c95c)
• docs: add MIT License file (e202d34)

Installation

pip install sphinxcontrib-typst==0.2.2

Release v0.2.1

Changes since v0.2.0

• fix: remove hardcoded version check in test_setup_version_matches (d22590e)
• chore: update version in pyproject.toml to 0.2.1 (7868538)
• chore: release v0.2.1 (0cecb7b)
• Merge pull request #24 from YuSabo90002/fix/issue-21-rst-comments (6b96f12)
• chore: archive OpenSpec change fix-rst-comments (5be88f0)
• fix: skip RST comments in Typst output (737c6ef)
• Merge pull request #23 from YuSabo90002/chore/archive-openspec-fix-table-duplication (45f4056)
• Merge branch 'main' into chore/archive-openspec-fix-table-duplication (44a1a30)
• chore: archive OpenSpec change fix-table-duplication (331ce57)
• Merge pull request #22 from YuSabo90002/fix/issue-19-table-duplication (0780e6e)
• style: fix import ordering in test_translator.py (d687fef)
• docs: add TDD-first task template to AGENTS.md (df65b2b)
• fix: resolve table content duplication in Typst output (#19) (a0f3c78)
• docs: expand spec.md to cover all table formats (f6c1c9f)
• docs: update proposal to reflect all table types affected (2196c81)
• docs: add OpenSpec proposal for table duplication fix (3688ba0)
• Merge pull request #18 from YuSabo90002/feature/migrate-to-openspec (b14e2f2)
• feat: migrate from Kiro to OpenSpec for spec-driven development (16b51ff)

Installation

pip install sphinxcontrib-typst==0.2.1

What's Changed

• Migrate from Kiro to OpenSpec for spec-driven development by @YuSabo90002 in #18
• Fix table content duplication in Typst output by @YuSabo90002 in #22
• Archive OpenSpec change: fix-table-duplication by @YuSabo90002 in #23
• Fix RST comments rendered as plain text in Typst output by @YuSabo90002 in #24

Full Changelog: v0.2.0...v0.2.1

Release v0.2.0

Changes since v0.1.0b1

• Merge pull request #17 from YuSabo90002/release/v0.2.0 (f0309a2)
• chore: release v0.2.0 (23634aa)
• Merge pull request #16 from YuSabo90002/docs/issue-6-remove-nodehandlerregistry (6210fc0)
• docs: document custom node support using Sphinx standard API (af36a19)
• Merge pull request #15 from YuSabo90002/improve/issue-7-simplify-toctree-block (54c1045)
• fix: resolve lint and format errors in test_toctree_requirement13.py (a68711f)
• fix: simplify toctree output with single content block (051f2d6)
• Merge pull request #14 from YuSabo90002/fix/issue-5-typst-cli-version-check (e9dd705)
• fix: resolve lint, format, and type check errors (2eeb571)
• docs(steering): update project documentation with Issue #5 implementation (20b4aa7)
• docs: add comprehensive debug logging and documentation for nested toctree (79f74aa)
• test: improve code coverage to 94% with additional toctree parameter tests (41d8f21)
• test: add E2E Typst compilation tests and fix toctree parameter handling (98bbccd)
• test: add integration tests for nested toctree relative paths (887260a)
• test: add integration test fixtures for nested toctree (Task 3) (c9e487b)
• feat: fix nested toctree relative paths (Issue #5) (041c148)
• Merge pull request #12 from YuSabo90002/test/verify-issue-10 (48361ad)
• docs(spec): update tasks.md for dual builder entry points (1f8733d)
• test: add test coverage for typstpdf entry point (dc3af49)
• docs(spec): update requirements and design for dual builder entry points (80c432d)
• docs: update README to reflect optional extension registration (83864c4)
• docs: update usage guide to reflect optional extension registration (fc27ba5)
• fix: register typstpdf builder in entry points for auto-discovery (80de950)
• Merge pull request #11 from YuSabo90002/docs/improve-claude-md-documentation (1ce9a5f)
• docs: improve CLAUDE.md with repository info and guidelines (0b56977)
• Merge pull request #9 from YuSabo90002/docs/add-ai-acknowledgment (99e4589)
• docs: add acknowledgment for AI-assisted development (0cbbcc3)
• build(deps): bump codecov/codecov-action from 4 to 5 (67461be)
• build(deps): bump actions/checkout from 4 to 5 (eb8f4e2)
• build(deps): bump astral-sh/setup-uv from 4 to 7 (1f7d915)
• Fix TestPyPI condition: use inputs context correctly (323a359)
• Fix TestPyPI condition for manual workflow dispatch (f170662)
• Fix release workflow: use official PyPI publish action (fe9901e)
• Add automated release workflow (63136d5)
• Fix Dependabot configuration (1388813)
• Add issue templates and Dependabot configuration (813f31b)
• Fix toctree output: replace {} with #[...] content blocks (f043c3a)
• Fix CI workflow: use uv sync for all jobs (4f5dcf0)
• Fix version test for v0.1.0b1 (975c0bb)

Installation

pip install sphinxcontrib-typst==0.2.0

v0.1.0b1 (Beta Release)

sphinxcontrib-typst v0.1.0b1 - Initial Beta Release

🎉 First beta release of sphinxcontrib-typst!

Overview

sphinxcontrib-typst is a Sphinx extension that enables generating Typst documents from reStructuredText sources. This beta release provides a comprehensive set of features for converting Sphinx documentation to Typst format and generating PDF output.

Key Features

• Sphinx Builder Integration: Standard typst and typstpdf builders
• Comprehensive Node Support: 70+ standard docutils nodes + 14+ Sphinx addnodes
• Mathematical Expressions:
  • LaTeX syntax via mitex (@preview/mitex:0.2.4)
  • Native Typst math syntax
  • Fallback mode for basic LaTeX→Typst conversion
• Code Highlighting: Using codly (@preview/codly:1.3.0) with automatic line numbering
• Admonitions: Beautiful admonitions via gentle-clues (@preview/gentle-clues:1.2.0)
• Multi-Document Support: toctree → #include() with heading level adjustment
• Self-Contained PDF Generation: No external Typst CLI required (uses typst-py)
• Custom Templates: Flexible template system with parameter mapping

Installation

pip install sphinxcontrib-typst

Quick Start

# conf.py
extensions = ['sphinxcontrib.typst']

# Generate Typst files
sphinx-build -b typst source build/typst

# Generate PDF directly
sphinx-build -b typstpdf source build/pdf

Stats

• Requirements: 12 out of 13 fully implemented (92%)
• Tests: 286 tests passing
• Code Coverage: 93%
• Python Support: 3.9, 3.10, 3.11, 3.12
• CI/CD: GitHub Actions with test matrix, lint, type-check, coverage

Known Limitations

• Requirement 11 (Extensibility and Plugin Support): Custom node handler registry not yet implemented
  • Planned for v0.2.0
  • Workaround: Extend TypstTranslator directly
• Bibliography: BibTeX integration not yet supported
• Glossary: Glossary generation not yet supported

Documentation

• Installation Guide
• Usage Guide
• Configuration Reference
• Examples

Dependencies

• Python ≥3.9
• Sphinx ≥5.0
• docutils ≥0.18
• typst (typst-py) ≥0.11.1

What's Next (v0.2.0)

• Custom node handler registry (Requirement 11)
• BibTeX/bibliography support
• Glossary generation
• Index generation
• Additional Typst Universe template integration

---

Feedback and Contributions Welcome!

Please report issues or submit pull requests on GitHub.

🤖 Generated with Claude Code

---

📦 PyPI Release

Package is now available on PyPI!

Installation

pip install sphinxcontrib-typst

Links

• PyPI: https://pypi.org/project/sphinxcontrib-typst/0.1.0b1/
• TestPyPI: https://test.pypi.org/project/sphinxcontrib-typst/0.1.0b1/

Quick Start

# conf.py
extensions = ['sphinxcontrib.typst']

# Generate Typst files
sphinx-build -b typst source build/typst

# Generate PDF directly
sphinx-build -b typstpdf source build/pdf