Home /Modules/docs/README.md

README.md

docs/api/README.md · 39 line(s) · markdown

SLeeLa API documentation build

This directory is the contributor-facing HTML API site generated from the current /lib source tree. Open index.html to browse package, class, field, and method documentation. The current normative language edition is SLeeLa syntax 3.0.

Build all API destinations

From the repository root:

make api-docs

The build uses tools/generate-sleeladoc-api.py to produce:

  1. /sleeladoc-api — the live generated reference.
  2. /docs/api — this contributor-facing copy.
  3. /api/sleela/3.0/version-NNN — an immutable, versioned API snapshot.

The generator reads the checked-in source comments and declarations. It reports each unit's actual #sleela pragma and does not rewrite older source versions when a new language specification edition is published.

See the API catalogue, SLeeLa 3.0 edition, and SleelaDoc source convention.

Language-level additions (not /lib classes)

Language/compiler features specified in SLEELA.syntax are documented by hand under the 3.0 edition (they are not /lib package pages):

The OP_SLEEP (157) and OP_BIGMUL (156) opcodes appear on this site's generated vm package page as SLISASleep / SLISABigMul.