User Guide

This section provides comprehensive documentation on using typsphinx.

• Configuration
  • Basic Configuration
  • Template Configuration
  • Math Rendering
  • Code Highlighting
  • Author Information
  • Paper Size and Format
  • Complete Example
  • See Also
• Builders
  • Overview
  • typst Builder
  • typstpdf Builder
  • Configuration
  • Choosing a Builder
  • Common Workflow
  • See Also
• Templates
  • Template System Overview
  • Default Template
  • Configuration-Based Templates
  • Custom Template Files
  • Template Parameters
  • Wrapping External Packages
  • Examples
  • Best Practices
  • Debugging Templates
  • See Also

Overview

typsphinx integrates Sphinx with Typst to provide high-quality PDF output without the complexity of LaTeX.

The extension provides two builders:

• typst: Generates Typst markup files (.typ)

• typstpdf: Generates PDF files directly using typst-py

Main Topics

Configuration

Learn about all configuration options available in conf.py

Builders

Understand the difference between typst and typstpdf builders

Templates

Customize output using Typst templates