Repository files navigation

Generate address space documentation HTML from compiled SystemRDL input.

For the command line tool, see thePeakRDL project.

Install fromPyPi using pip:

python3 -m pip install peakrdl-html

The easiest way to use PeakRDL-html is via thePeakRDL command line tool:

# Install the command line toolpython3 -m pip install peakrdl# Generate HTMLpeakrdl html your_design.rdl -o output_dir

Here is anexample of HTML output generated from afictional SystemRDL register description:turboencabulator.rdl.

If using thePeakRDL command-line tool, someadditional 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

Constructor for the HTML exporter class

Optional Parameters

• markdown_inst
  • Override the class instance of the Markdown processor.See theMarkdown modulefor more details.
  • By default, the following extensions are loaded: 'extra', 'admonition', 'mdx_math'
• user_template_dir
  • Path to a directory where user-defined template overrides are stored.
• user_static_dir
  • Path to user-defined static content to copy to output directory.
• user_context
  • Additional context variables to load into the template namespace.
• show_signals
  • Show signal components. Default is False
• extra_doc_properties

  • List of properties to explicitly document.

    Nodes that have a property explicitly set will show its value in a tablein the node's description. Use this to bring forward user-definedproperties, or other built-in properties in your documentation.

• generate_source_links
  • IfTrue, attempts to generate links back to original RDL source deginitions.Defaults toTrue.
• gitmetheurl_translators
  • Override the list ofGitMeTheURL translators to use when generating source links.If unset, GitMeTheURL uses its builtin translators, as well as any installed plugins.

Perform the export!

Parameters

• nodes
  • Top-level node to export. Can be the top-levelRootNode or any internalAddrmapNode.Can also be a list ofRootNode and any internalAddrmapNode.
• output_dir
  • HTML output directory.

Optional Parameters

• footer
  • Override footer text.
• title
  • Override title text.
• home_url
  • If a URL is specified, adds a home button to return to a parent home page.
• skip_not_present
  • Control whether nodes withispresent=false are generated. Default is True.

Pass the elaborated output of theSystemRDL Compilerinto the exporter.

Assumingroot is the elaborated top-level node, or an internalAddrmapNode:

frompeakrdl_htmlimportHTMLExporterexporter=HTMLExporter()exporter.export(root,"path/to/output")