Skip Navigation
Instance PropertyProperty

externalDocumentationURLs

Base URLs of the hosted documentation of modules outside the generated site.

var externalDocumentationURLs: [String : URL]

Mentioned in

Discussion

When a page refers to a symbol of a module that is not part of the generated documentation, such as a type of an excluded dependency, the reference links to the symbol’s page below the base URL configured for that module, following DocC’s path convention <base>/documentation/<module>/<path>/. The base URL is the root of the hosted documentation, without /documentation.

A key is a module name, or the name or identity of a package dependency, which applies the URL to all modules of that package; names are matched ignoring case, and a module key takes precedence over the key of its package (see ExternalDocumentation). Keys are also matched against the bundle identifiers of doc:// links in documentation text. References to modules outside the site without a base URL are shown as unlinked text.