(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-cacheprocedureClear the documentation cache.
Use this to force reloading of documentation files after they have been regenerated.
module-name->doc-pathprocedureConvert a module name to its documentation file path (relative).
The path matches the .sgb bytecode location but with .json extension.
find-doc-fileprocedureCheck if documentation exists for a module.
Uses the unified resource resolution (project -> bundle -> system).
load-module-detailsprocedureLoad 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-descriptionprocedureGet the module-level documentation string.
Returns the module's docstring, or #f if not found.
get-export-detailsprocedureGet documentation for a specific export from a module.
Returns an <export-details> struct, or #f if the module or export is not found.
module-detailsprocedureConstruct a module-details struct.
Re-exported from (sigil docs types)
module-details?procedureTest if a value is a module-details struct.
Re-exported from (sigil docs types)
module-details-nameprocedureGet the name field of a module-details struct.
Re-exported from (sigil docs types)
module-details-fileprocedureGet the file field of a module-details struct.
Re-exported from (sigil docs types)
module-details-packageprocedureGet the package field of a module-details struct.
Re-exported from (sigil docs types)
module-details-descriptionprocedureGet the description field of a module-details struct.
Re-exported from (sigil docs types)
module-details-exportsprocedureGet the exports field of a module-details struct.
Re-exported from (sigil docs types)
module-details-syntaxesprocedureGet the syntaxes field of a module-details struct.
Re-exported from (sigil docs types)
module-details-examplesprocedureGet the examples field of a module-details struct.
Re-exported from (sigil docs types)
export-detailsprocedureConstruct a export-details struct.
Re-exported from (sigil docs types)
export-details?procedureTest if a value is a export-details struct.
Re-exported from (sigil docs types)
export-details-nameprocedureGet the name field of a export-details struct.
Re-exported from (sigil docs types)
export-details-kindprocedureGet the kind field of a export-details struct.
Re-exported from (sigil docs types)
export-details-signatureprocedureGet the signature field of a export-details struct.
Re-exported from (sigil docs types)
export-details-descriptionprocedureGet the description field of a export-details struct.
Re-exported from (sigil docs types)
export-details-examplesprocedureGet the examples field of a export-details struct.
Re-exported from (sigil docs types)
export-details-source-moduleprocedureGet the source-module field of a export-details struct.
Re-exported from (sigil docs types)
syntax-detailsprocedureConstruct a syntax-details struct.
Re-exported from (sigil docs types)
syntax-details?procedureTest if a value is a syntax-details struct.
Re-exported from (sigil docs types)
syntax-details-nameprocedureGet the name field of a syntax-details struct.
Re-exported from (sigil docs types)
syntax-details-patternsprocedureGet the patterns field of a syntax-details struct.
Re-exported from (sigil docs types)
syntax-details-descriptionprocedureGet the description field of a syntax-details struct.
Re-exported from (sigil docs types)
syntax-details-examplesprocedureGet the examples field of a syntax-details struct.
Re-exported from (sigil docs types)