autolink_references

docblock 
autolink_references(text::String, index::ReferenceIndex) -> String

Convert function references in backticks to hyperlinks.

Patterns matched:

  • \(`function_name()`\) -> [function_name()](reference/function_name.qmd)
  • \(`function_name`\) -> [function_name](reference/function_name.qmd) (if in index)

Arguments

  • text::String: Text containing references
  • index::ReferenceIndex: Reference index for lookups

Returns

Text with references converted to markdown links.

Example

index = build_reference_index(MyModule)
text = "Use `my_function()` to process data."
autolink_references(text, index)
# "Use [`my_function()`](reference/my_function.qmd) to process data."
docblock 
autolink_references(text::String, module_name::Module) -> String

Convenience method that builds the index automatically.

Arguments

  • text::String: Text containing references
  • module_name::Module: Module to use for reference lookups