build_reference_index

Notedocblock

reference_page_names 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”)
• recursive::Bool: When true, include documented bindings from submodules and use the collision-safe page names from reference_page_names so that autolink targets match the actual generated files. Entries are keyed by the collision-safe page name and, when that bare name is unambiguous, also by the bare name — so both \(`Inner.foo`\) and an unambiguous \(`bar`\) mention autolink (default: false).

Returns

A ReferenceIndex with all documented symbols.

Example

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