Omni.UI Documentation Builder

Extension: omni.kit.documentation.builder-1.0.19

Documentation Generated: Aug 12, 2025

The Documentation Builder extension finds enabled extensions with a [documentation] section in their extension.toml and adds a menu to show that documentation in a popup window. Extensions do not need to depend on omni.kit.documentation.builder to enable this functionality.

For example:

[documentation]
pages = ["docs/Overview.md"]
menu = "Help/API/omni.kit.documentation.builder"
title = "Omni UI Documentation Builder"

Documentation pages may contain code blocks with omni.ui calls that will be executed and displayed inline:

```execute
import omni.ui as ui
ui.Label("Hello World!")
```

generate_for_sphinx

omni.kit.documentation.builder.generate_for_sphinx can be called to generate documentation offline for sphinx web pages:

import omni.kit.app
import omni.kit.documentation.builder as builder
manager = omni.kit.app.get_app().get_extension_manager()
all_exts = manager.get_extensions()
for ext in all_exts:
    if ext.get("enabled", False):
        builder.generate_for_sphinx(ext.get("id", ""), f"/docs/{ext.get('name')}")

create_docs_window

Explicity create a documentation window with the omni.kit.documentation.builder.create_docs_window function:

import omni.kit.documentation.builder as builder
builder.create_docs_window("omni.kit.documentation.builder")