Skip to main content

HTML documentation generator for SystemRDL-based register models

Project description

PyPI - Python Version


Generate address space documentation HTML from compiled SystemRDL input


Install from PyPi using pip:

python3 -m pip install ralbot-html


An example of HTML output generated from a fictional SystemRDL register description.


Pass the elaborated output of the SystemRDL Compiler into the exporter.

Assuming root is the elaborated top-level node, or an internal AddrmapNode:

from ralbot.html import HTMLExporter

exporter = HTMLExporter()

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



Constructor for the HTML exporter class

Optional Parameters

  • markdown_inst
    • Override the class instance of the Markdown processor. See the Markdown module for more details.
  • 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

HTMLExporter.export(node, output_dir, **kwargs)

Perform the export!


  • nodes
    • Top-level node to export. Can be the top-level RootNode or any internal AddrmapNode. Can also be a list of RootNode and any internal AddrmapNode.
  • 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ralbot-html, version 1.5.0
Filename, size File type Python version Upload date Hashes
Filename, size ralbot-html-1.5.0.tar.gz (5.5 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page