peakrdl-html

library2.12.2pypypi✓ verified 83d ago

PeakRDL-html is a plugin for the PeakRDL parser that generates interactive HTML documentation for SystemRDL-based register models. It processes RDL source files to produce browsable web pages detailing register maps, fields, and properties. The current version is 2.12.2, and it maintains an active development cycle with regular updates addressing bug fixes and new features.

web-framework data

pip install peakrdl-html

github ↗package ↗changelog ↗

INSTALL

IMPORT

SIG · PEAKRDL-HTML

peakrdl-html

web-frameworkpythonv2.12.2

Install

3.2s avg

Import

—

Disk

67MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v2.12.2 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.920 runs

installs and imports cleanly · install 0.0s · import 0.000s · 66.1MB

glibc

py 3.10–3.920 runs

installs and imports cleanly · install 3.2s · import 0.000s · 70MB

67MB installed

● package 67MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

HTMLExporter

✓ from peakrdl_html import HTMLExporter

✗ from peakrdl_html.backend import HtmlBackend

This quickstart demonstrates how to create a minimal SystemRDL file and then use the `peakrdl` command-line tool with the `--html` flag to generate documentation. The output HTML files will be placed in the specified 'docs' directory. Ensure `peakrdl-html` is installed, which will also pull in `peakrdl`.

echo 'addrmap my_block { reg my_reg { field { hw=w; sw=r; } my_field[32]; } @0x0; };' > example.rdl pip install peakrdl-html peakrdl --html -o docs example.rdl ls docs/index.html

peakrdl --version

Debug

Known issues

breakingPython 3.5 and 3.6 support was dropped in v2.11.0. Users on these older Python versions will encounter 'Unsupported Python version' errors or installation failures.

fix

Upgrade to Python 3.7 or newer. Python 3.7 is the minimum requirement for versions 2.11.0 and above.

affects: >=2.11.0

deprecatedInline math tags using escaped parentheses `\(...)\` were deprecated in v2.11.0 and will be removed in v3.0. These should be replaced with dollar-style `$...$` inline math tags.

fix

Update your SystemRDL source files to use `$...$` for inline math expressions instead of `\(...)\`.

affects: >=2.11.0

breakingThe `peakrdl.html` namespace package was removed in v2.10.0. Any direct imports from this path will now fail.

fix

If you were programmatically interacting with `peakrdl.html` components, you may need to adjust imports. For typical usage, rely on the `peakrdl --html` command-line interface, as direct Python API usage for generation is less common.

affects: >=2.10.0

Upgrade

Version history

2.12.2latest on PyPI · released Mar 6, 2026

Audit

Dependencies

peakrdlrequiredPeakRDL-html is a plugin for the PeakRDL parser; 'peakrdl' is a direct runtime dependency.

Jinja2requiredUsed for templating the HTML output.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/SystemRDL/PeakRDL-html ↗

packagehttps://pypi.org/project/peakrdl-html/ ↗

changeloghttps://github.com/SystemRDL/PeakRDL-html/releases ↗