Using KPM iframes inside docs¶

It is possible to use the kpm_iframe Sphinx directive to embed KPM directly inside a doc.

Usage¶

```{kpm_iframe}
:spec: <KPM specification .json file URI>
:dataflow: <KPM dataflow .json file URI>
:preview: <a boolean value specifying whether this KPM should be started in preview mode>
:height: <a string css height property that sets the `height` of iframe>
:alt: <a custom alternative text used in the PDF documentation instead of the default one>
```

URI can represent either a local file from sources that gets copied into the build directory, or a remote resource.

All parameters of this directive are optional.

Tests¶

Use remote specification¶

Use local files¶

Open in preview mode¶

Use custom alt text¶