svblock

Contents

  • Getting Started
    • Installation
      • Requirements
    • Quick Start
      • Common Workflows
    • Development Installation
  • CLI Reference
    • Synopsis
    • Positional Arguments
    • Options
    • Exit Codes
    • Examples
  • Port Grouping
    • Annotation-Driven Grouping
      • Group Assignment
      • Annotation Syntax
    • Heuristic Grouping
    • Disabling Grouping
  • Themes
    • Built-in Themes
    • CSS Variables
    • Custom Themes
      • TOML Format
      • YAML Format
      • Theme in Sphinx
  • Examples
    • Simple Module
    • Annotated Module with Groups
    • Bus Ports with Parameters
    • Interface Ports
    • Large Module
    • Pin Decorators
  • Sphinx Extension
    • Setup
    • Basic Usage
    • Directive Options
    • Examples
    • Error Handling
    • How It Works
  • Architecture
    • Pipeline Stages
      • Stage 1: Parser
      • Stage 2: Module IR
      • Stage 3: Layout
      • Stage 4: SVG Renderer
    • Supporting Modules
      • Exporters
      • Sphinx Extension
      • Configuration
    • Directory Structure
  • API Reference
    • Data Model
      • PortDirection
      • PortDef
      • ParamDef
      • GroupDef
      • ModuleIR
    • Parser
      • ParseError
      • extract_module()
      • extract_modules()
      • parse_annotations_from_text()
      • parse_annotations_from_file()
    • Layout
      • PinSide
      • DecoratorType
      • PinRow
      • GroupSeparator
      • HeaderRect
      • LayoutConfig
      • LayoutSpec
      • compute_layout()
      • apply_grouping()
      • measure_text()
    • Renderer
      • RenderOptions
      • render_svg()
    • Configuration
      • load_theme()
    • Exporters
      • svg_to_png()
      • svg_to_pdf()
    • Programmatic Usage
  • Contributing
    • Development Setup
    • Running Tests
    • Linting
    • Type Checking
    • Snapshot Tests
    • Test Fixtures
    • Project Structure
svblock
  • Search

© Copyright 2026, Glen Zachariah.

Built with Sphinx using a theme provided by Read the Docs.