RST

API reference

The public API is organized by task. Types marked @internal in source are implementation details and are not part of the package contract.

Entry points

Rst::docutils(), Rst::sphinx(), and Rst::symfony() create immutable engines with a selected profile. Each engine exposes profile(), profileName(), parse(), and toHtml().

<?php
use Alto\Rst\Rst;

$rst = Rst::sphinx();
$parsed = $rst->parse($source);

Reference domains

  • Parsing: engines, profiles, sources, nodes, and parse results.
  • Rendering: HTML renderer, options, and URL policy.
  • Quality: linting, safe fixes, and formatting.
  • Editing: typed editor, patches, diffs, and files.
  • Conversion: document and project converters.
  • References: local and cross-document resolution.
  • Extensions: profile contribution contracts.
  • Exceptions: invalid arguments, patches, and files.

Use guide pages for workflows and decisions. These pages define the callable surface and observable boundaries.