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 the iframe>
:alt: <a custom alternative text used in the PDF documentation instead of the default one>
```
URI
represents either a local file from sources that are copied into the build directory, or a remote resource.
All parameters in this directive are optional.
Tests¶
Use remote specification¶
Note
The graph below is supposed to be empty.
It doesn’t load a dataflow, only a specification that provides IP-cores to the Nodes browser on the sidebar.
Use local files¶
Open in preview mode¶
Use a custom alt text¶
Note
The alternative text is visible instead of the iframe in the PDF version of this documentation.
Last update:
2024-12-10