sigildocs

(sigil docs commands)

(sigil docs commands) - Documentation validation and API generation

Provides commands for checking documentation code blocks and generating API documentation from source files.

For building and serving documentation sites, use sigil publish.

Exports

docs-handlerprocedure

Main handler for sigil docs command

Check documentation code blocks

Generate API documentation

Extract package name from a workspace package path "packages/sigil-stdlib" => "sigil-stdlib"

Get package order from workspace, if available Returns #f if no workspace found, or list of package names in order

find-packagesprocedure

Find all packages, respecting workspace order when available

Extract docs from all packages

Extract docs from a single package

Find all .sgl files recursively

Check coverage for all packages

Generate API pages for all packages

Generate package index page

URL-encode a string for fragment identifiers

Generate HTML for a module

Generate symbol index and landing page

Extract summary from description

Parse description as markdown

Generate landing page

Generate symbols page

Collect symbols from packages

Scan directory for markdown files

Check all files for code blocks

check-fileprocedure

Check a single file

Extract code blocks from SXML

Generate session name from file path

Execute blocks and report

Check for REPL style

Execute a code block

Execute REPL-style block

Parse REPL entries

Check balanced parens

Execute single REPL entry

Format result for comparison

Check results match

Check float match

truncate-codeprocedure

Truncate code for display

Show help