peakrdl_html
peakrdl_html(IP_LIB **kwargs)
Create a target for invoking PeakRDL-html on IP_LIB.
PeakRDL-html generates HTML documentation out of the SystemRDL inputs.
An example of generated documentation can be found here
Function expects that ${IP_LIB} has SYSTEMRDL_SOURCES property set with a list of SystemRDL files to be used as inputs. To set the SYSTEMRDL_SOURCES property use the ip_sources()
ip_sources(ip SYSTEMRDL ${PROJECT_SOURCE_DIR}/file.rdl)
Parameters
| Name | Type | Description |
|---|---|---|
IP_LIB | string | The target IP library. |
Keyword Arguments
| Name | Type | Description |
|---|---|---|
OUTDIR | string | Output directory for the generated HTML files. If omitted, ${BINARY_DIR}/html will be used. |
SERVER_TARGET | bool | If set, also creates a target that launches a local HTTP server at 0.0.0.0:8000 to browse the generated documentation. |
ARGS | list | any additional arguments to pass to peakrdl cli |