register_external_docs

Notedocblock

Inventory Register an external package’s documentation for cross-referencing.

The base_url is stored, and an Inventory is associated with the package so that references can be resolved to real URLs:

  • If inventory is an Inventory, it is used directly.
  • If inventory is a String, it is treated as a path/URL to an objects.inv and loaded.
  • If inventory is nothing (the default), this attempts to load "$base_url/objects.inv". Network/parse failures are caught and degrade gracefully to “no inventory” (the package is still registered, but its references will not resolve until an inventory is available).

Arguments

  • package::String: Package name (e.g., “DataFrames”).
  • base_url::String: Base URL for the package docs (e.g., “https://dataframes.juliadata.org/stable”).
  • inventory: An Inventory, a path/URL string, or nothing (default).
  • registry: Registry to add to (default: global registry).

Example

Inventory