sigildocs

(sigil docs lookup)

(sigil docs lookup) - JSON-based Documentation Lookup

Loads and queries documentation from JSON files generated during compilation. JSON doc files are co-located with .sgb bytecode files and are found using the same load path search as module loading.

Example: (load-module-details '(sigil string)) => <module-details> struct with exports list

(get-export-details '(sigil string) 'string-split) => <export-details> struct with name, kind, doc, signature

Exports

clear-doc-cacheprocedure

Clear the documentation cache.

Use this to force reloading of documentation files after they have been regenerated.

module-name->doc-pathprocedure

Convert a module name to its documentation file path (relative).

The path matches the .sgb bytecode location but with .json extension.

find-doc-fileprocedure

Check if documentation exists for a module.

Uses the unified resource resolution (project -> bundle -> system).

load-module-detailsprocedure

Load documentation for a module from its JSON file.

Returns a <module-details> struct, or #f if no documentation file is found. The result is cached for subsequent lookups.

get-module-descriptionprocedure

Get the module-level documentation string.

Returns the module's docstring, or #f if not found.

get-export-detailsprocedure

Get documentation for a specific export from a module.

Returns an <export-details> struct, or #f if the module or export is not found.

module-detailsvariable

(No description)

module-details?variable

(No description)

module-details-namevariable

(No description)

module-details-filevariable

(No description)

module-details-packagevariable

(No description)

module-details-descriptionvariable

(No description)

module-details-exportsvariable

(No description)

module-details-syntaxesvariable

(No description)

module-details-examplesvariable

(No description)

export-detailsvariable

(No description)

export-details?variable

(No description)

export-details-namevariable

(No description)

export-details-kindvariable

(No description)

export-details-signaturevariable

(No description)

export-details-descriptionvariable

(No description)

export-details-examplesvariable

(No description)

export-details-source-modulevariable

(No description)

export-details-linevariable

(No description)

syntax-detailsvariable

(No description)

syntax-details?variable

(No description)

syntax-details-namevariable

(No description)

syntax-details-patternsvariable

(No description)

syntax-details-descriptionvariable

(No description)

syntax-details-examplesvariable

(No description)