sigil-docs

Documentation lookup and search tooling for Sigil projects.

Overview

(sigil docs) provides JSON-based documentation lookup for REPL inline help and tooling integration (LSP hover, MCP tools, format hints). Doc JSON files are generated by the Sigil compiler during compilation.

Sub-modules:

• (sigil docs) — top-level surface re-exporting the lookup API
• (sigil docs lookup) — JSON-based doc lookup
• (sigil docs types) — doc record type definitions
• (sigil docs search) — documentation search across modules
• (sigil docs index) — doc-index assembly
• (sigil docs packages) — package-level doc lookup

Usage

(import (sigil docs))

;; Look up an export's docs
(get-export-details '(sigil string) 'string-split)

;; Get a module's top-level description
(get-module-description '(sigil docs))

Building and testing

sigil deps install
sigil build
sigil test --report

For local development against an unreleased sigil-lang / sigil-args / sigil-ansi / sigil-json checkout, use dev-redirects.sgl:

sigil deps install --redirects ./dev-redirects.sgl

License

BSD-3-Clause. See LICENSE.