Generate address space documentation HTML from compiled SystemRDL input
Generate address space documentation HTML from compiled SystemRDL input.
For the command line tool, see the PeakRDL project.
Install from PyPi using pip:
python3 -m pip install peakrdl-html
The easiest way to use PeakRDL-html is via the PeakRDL command line tool:
# Install the command line tool
python3 -m pip install peakrdl
# Generate HTML
peakrdl html your_design.rdl -o output_dir
Here is an example of HTML output generated from a fictional SystemRDL register description: turboencabulator.rdl.
If using the PeakRDL command-line tool, some additional things can be configured via the TOML configuration file.
[html]
user_template_dir = "path/to/dir/"
user_static_dir = "path/to/dir/"
extra_doc_properties = ["list", "of", "properties"]
generate_source_links = false
HTMLExporter(**kwargs)
Constructor for the HTML exporter class
Optional Parameters
markdown_inst
user_template_dir
user_static_dir
user_context
show_signals
extra_doc_properties
List of properties to explicitly document.
Nodes that have a property explicitly set will show its value in a table in the node's description. Use this to bring forward user-defined properties, or other built-in properties in your documentation.
generate_source_links
True
, attempts to generate links back to original RDL source deginitions.
Defaults to True
.gitmetheurl_translators
HTMLExporter.export(node, output_dir, **kwargs)
Perform the export!
Parameters
nodes
RootNode
or any internal AddrmapNode
.
Can also be a list of RootNode
and any internal AddrmapNode
.output_dir
Optional Parameters
footer
title
home_url
skip_not_present
ispresent=false
are generated. Default is True.Pass the elaborated output of the SystemRDL Compiler into the exporter.
Assuming root
is the elaborated top-level node, or an internal AddrmapNode
:
from peakrdl_html import HTMLExporter
exporter = HTMLExporter()
exporter.export(root, "path/to/output")