documentation

The documentation key supports 3 types of documentation pages.

Documentation from docs.silabs.com

Required: No
Type: Page on docs.silabs.com
Condition: Partial (only document)

Reference to a single page of documentation on docs.silabs.com relevant for the component.

Key	Required	Type	Description
docset	Yes	String	ID of docset
document	Yes	List of page references	List of maps with keys page and optionally condition/unless. The value of page is the name of a documentation page.
		String	Name of a single documentation page.

documentation:
  docset: gecko-platform
  document:
    - page: emlib/efm32g/api/group-acmp
      condition: [device_sdid_71]
    - page: emlib/efm32gg/api/group-acmp
      condition: [device_sdid_73]
---
documentation:
  docset: gecko-platform
  document: service/api/group-sleeptimer

The version information from the .slcs file for the given docset is combined with the information from the component to construct a link to the documentation page.

Local Documentation

Required: No
Type: Local documentation page
Condition: No

Reference to a single page of documentation shipped together with the component.

Key	Required	Type	Description
page	Yes	String	Path to documentation page

Online Documentation

Required: No
Type: Online documentation page
Condition: No

Reference to a single page of documentation available online.

Key	Required	Type	Description
url	Yes	String	URL to online documentation page