`(sigil docs index)`

(sigil docs index) - Documentation Index Generation

Generates an index.json file from individual module documentation JSON files. This provides a consolidated view of all modules and exports for quick lookup.

Use cases:

Documentation site build: index packages being documented
IDE integration: index all modules across load paths
REPL: lazy symbol search

(import (sigil docs index))

;; Generate index for a lib directory
(generate-docs-index "build/dev/lib")

;; Generate index for specific JSON files
(generate-docs-index-from-files output-path json-file-list)

Exports

build-index-from-json-filesprocedure

Build an index data structure from a list of JSON file paths.

Returns a dict with:

modules: array of module entries
symbols: dict mapping symbol names to module/kind/summary

(build-index-from-json-files '("lib/sigil/json.json" "lib/sigil/io.json"))

generate-docs-index-from-filesprocedure

Generate index.json from specific JSON files.

Processes the given JSON files and writes the index to output-path.

(generate-docs-index-from-files
  "build/dev/lib/index.json"
  '("build/dev/lib/sigil/json.json"))

generate-docs-indexprocedure

Generate index.json from all module JSON files in a directory.

Scans lib-dir for .json documentation files and creates a consolidated index at lib-dir/index.json.

(generate-docs-index "build/dev/lib")