build_reference_index

docblock 
build_reference_index(module_name::Module; base_path::String="reference") -> ReferenceIndex

Build a lookup table mapping function names to their reference page URLs.

Arguments

  • module_name::Module: Module to index
  • base_path::String: Base path for reference pages (default: “reference”)

Returns

A ReferenceIndex with all documented symbols.

Example

index = build_reference_index(MyModule)
index.entries["my_function"]  # "reference/my_function.qmd"