{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/software-development-documentation"},{"label":"Electronic Design Automation (EDA)","url":"https://skillfed.io/packages/category/scientific-engineering-electronic-design-automation-eda"}],"enrichment":{"capability":"Generates HTML documentation for register address spaces from compiled SystemRDL register descriptions, converting hardware register models into browsable web documentation.","skillfed_tags":["hardware-design","register-documentation","eda"],"use_cases":["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."],"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.\n\nThe 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.","worth_installing":"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."},"id":"peakrdl-html","links":{"html":"https://skillfed.io/packages/peakrdl-html","md":"https://skillfed.io/packages/peakrdl-html.md","pypi":"https://pypi.org/project/peakrdl-html/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2026-03-06","license_spdx":null,"license_treatment":"copyleft","name":"peakrdl-html","python_support":"supports_current","summary":"HTML documentation generator for SystemRDL-based register models"},"popularity":{"monthly_downloads":195830,"position":9804,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"2.12.2"}
