InventoryItem

Notedocblock

item_uri A single entry in a Sphinx objects.inv inventory.

Fields

  • name::String: Fully qualified object name (e.g. "MyPkg.myfunction").
  • domain::String: Domain of the object (Julia inventories use "jl").
  • role::String: Role within the domain (e.g. "function", "type").
  • priority::Int: Search priority (Documenter uses 1).
  • uri::String: URI relative to the inventory root. A trailing $ is shorthand for the object name (expanded by item_uri).
  • dispname::String: Display name. The sentinel "-" means it equals name.
Notedocblock 
InventoryItem(name, domain, role, priority, uri; dispname="-")

Convenience constructor with a default dispname of "-" (meaning the display name is identical to name).