Sphinx theme

A Sphinx themed called harmonic (old cosmic) is available. It is deeply based on ADI’s harmonic design language.

Shortcuts

Tip

Depending on your browser and operating system shortcuts, some shortcuts may collide with existing ones, therefore, multiple alternatives are provided.

Alt+Shift+ArrowLeft goes to the previous page and Alt+Shift+ArrowRight to the next page. Alternatively Alt+Shift+A and Alt+Shift+D. Ctrl+Alt+Shift+ArrowLeft/Right preserves the current page anchor, for example, if the current section is project_0.html#details, Ctrl+Alt+Shift+ArrowRight goes to project_1.html#details, even if details does not exist (same for A and D variants). This feature is useful for batch reviewing sections common to multiple pages, e.g. “Supported Devices”.

The /, Ctrl+K, Alt+K key triggers the search bar. In search, Use Ctrl+ incrementing values (1,2,3..B,C…,Z) to select the search locations. A is skipped because it is a common shortcut to select all text. Double tab from the focused search box focuses on the first result. esc exits the search.

Theme options

As other Sphinx themes, customization is provided through the conf.py. The options are added to the html_theme_options dictionary:

html_theme_options = {
    "light_logo": path.join("path", "to", "logo_light.svg"),
    "dark_logo": path.join("path", "to", "logo_dark.svg"),
    "no_index": False,
    "standalone": False,
}

For logos in the sidebar, provide a dark and light variant: If there is no dark variant, provide only light_logo.

To not index the doc in search engines, set no_index as True.

If you desire to disable cross-repository integration, set standalone as True. This option is not recommended in most cases, since the internal logic already manages the features on a context/deployment basis, while this flag will permanently disable the features for a build.