Skip Navigation
StructureStructure

ExternalDocumentation

The hosted documentation of modules that are not part of the generated site.

struct ExternalDocumentation

Overview

Pages of the generated site often refer to symbols of modules that the site does not document, such as the types of a dependency in a declaration, the protocols a type conforms to, or a symbol link in a documentation comment. When the documentation of such a module is hosted elsewhere, its base URL can be given in externalDocumentationURLs, keyed by the name of the module or by the name of the package that provides it. Links to the module’s symbols then point to their pages below that base URL, following DocC’s path convention: <base>/documentation/<module>/<path>/, with the module and path in lower case.

A key is matched, ignoring case, against

  1. the name of a module, such as FixtureColours, where hyphens and underscores are interchangeable, as Swift turns the hyphens of a target name into underscores; and

  2. the name of a package (the name in its manifest) or its identity (the last component of its location, such as fixture-palette), which applies the URL to every module of that package.

A key that names a module takes precedence over a key that names the package providing that module.

Topics

Relationships

  • Swift.Equatable
  • Swift.Sendable
  • Swift.SendableMetatype

See Also