peakrdl-html
HTML documentation generator for SystemRDL-based register models
Decision gist · record as of 2026-08-14
Yes. The package is actively maintained, has no known vulnerabilities, installs with low friction, and solves a specific and well-defined problem in the hardware design documentation workflow. The LGPLv3 license is standard for open-source tools and poses no barrier to most users. Install it if you work with SystemRDL register models and need to generate documentation.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires a compiled SystemRDL root node or AddrmapNode from systemrdl-compiler as input; the package is an exporter, not a compiler.
- Low friction install with a pure-Python wheel.
- The package is actively maintained with a recent release and no known vulnerabilities.
License · maintenance · safety
LGPLv3 (copyleft) — Licensed under LGPLv3 (copyleft). You can use this package freely, but any modifications you distribute must also be released under LGPLv3, and you must provide access to the modified source code.
last release 2026-03-06 (161 days) · last repo commit 2026-03-06 · 65 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 195,830 downloads/mo, #9,804 on PyPI
Alternatives
Verify before relying
from peakrdl_html import HTMLExporter
exporter = HTMLExporter()
exporter.export(root, "path/to/output")
# Or via command line:
# peakrdl html your_design.rdl -o output_dir- Whether the package works with Python versions beyond 3.7 (requires_python states >=3.7, but current Python support tier is not specified).
- Performance characteristics when exporting large register models or complex address spaces.
What it is and what it does
PeakRDL-html is a documentation generator that takes compiled SystemRDL register descriptions and produces browsable HTML documentation. It's designed as an exporter plugin for the PeakRDL ecosystem, accepting elaborated register trees and rendering them into static HTML with configurable templates, markdown support, and optional source-code links.
The package is typically used either through the PeakRDL command-line tool (the easiest path) or directly via its Python API by passing a compiled register model. It supports customization through user-defined templates, static assets, and configuration options like field ordering, signal visibility, and extra documentation properties. Dependencies include Jinja2 for templating, markdown processors for rich text support, and git-me-the-url for generating links back to register definitions in source control.
Use it for
- Generate browsable HTML documentation from SystemRDL register definitions for hardware design teams.
- Integrate register documentation into a CI/CD pipeline to auto-generate docs on each design update.
- Customize register documentation layout and styling by providing user-defined Jinja2 templates.
- Create links from generated documentation back to register definitions in a Git repository.
- Document user-defined register properties alongside built-in SystemRDL properties in HTML output.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
The package is actively maintained, has no known vulnerabilities, installs with low friction, and solves a specific and well-defined problem in the hardware design documentation workflow. The LGPLv3 license is standard for open-source tools and poses no barrier to most users. Install it if you work with SystemRDL register models and need to generate documentation.
Install
peakrdl-html on PyPI
Before you install
Low friction install with a pure-Python wheel. The package is actively maintained with a recent release and no known vulnerabilities. Five runtime dependencies are all standard Python packages (Jinja2, markdown, systemrdl-compiler, git-me-the-url, python-markdown-math), making installation straightforward.
Requires a compiled SystemRDL root node or AddrmapNode from systemrdl-compiler as input; the package is an exporter, not a compiler.
License in practice
Licensed under LGPLv3 (copyleft). You can use this package freely, but any modifications you distribute must also be released under LGPLv3, and you must provide access to the modified source code.
Quickstart
from peakrdl_html import HTMLExporter
exporter = HTMLExporter()
exporter.export(root, "path/to/output")
# Or via command line:
# peakrdl html your_design.rdl -o output_dirVerify before relying
- Whether the package works with Python versions beyond 3.7 (requires_python states >=3.7, but current Python support tier is not specified).
- Performance characteristics when exporting large register models or complex address spaces.
Package facts
| License | LGPLv3 copyleft |
| Python support | Supports the current Python release >=3.7 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 5 packagessystemrdl-compilerJinja2markdowngit-me-the-urlpython-markdown-math |
| Maintenance | Actively maintained 161 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 195,830 / month, #9,804 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableIntended Audience :: DevelopersLicense :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)Operating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyTopic :: Scientific/Engineering :: Electronic Design Automation (EDA)Topic :: Software Development :: Documentation |
Evidence: peakrdl_html-2.12.2-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “SystemRDL HTML documentation generator”
- peakrdl-htmlGenerates HTML documentation for register address spaces from…
- peakrdlPeakRDL is a control and status register (CSR) generator toolchain…
- peakrdl-cliPeakRDL is a command-line tool that generates register abstraction…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Converts Markdown text to HTML using a Python implementation of John Gruber's Markdown specification, with support for extensions.
Install it if you need to parse Markdown in Python.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
Material for MkDocs is a professional theme and extension for MkDocs that transforms Markdown documentation into a responsive, searchable static site with minimal configuration.
Install it if you need to publish Markdown-based documentation as a professional static site without writing custom HTML or CSS.
See also peakrdl-systemrdl · peakrdl-cheader · peakrdl-cli · peakrdl-uvm · peakrdl · peakrdl-regblock · systemrdl-compiler · peakrdl-ipxact · peakrdl-python