Skip to content

feat: add wavedrom bitfield support#5

Open
sjalloq wants to merge 1 commit into
SystemRDL:mainfrom
sjalloq:feat/wavedrom
Open

feat: add wavedrom bitfield support#5
sjalloq wants to merge 1 commit into
SystemRDL:mainfrom
sjalloq:feat/wavedrom

Conversation

@sjalloq

@sjalloq sjalloq commented Feb 18, 2026

Copy link
Copy Markdown

This commit adds support for inline wavedrom bitfield rendering. Each register gains an SVG view of the bit fields. Adds a dependenc on sphinxcontrib-yowasp-wavedrom.

@sjalloq

sjalloq commented Feb 18, 2026

Copy link
Copy Markdown
Author

@amykyta3 Wondering if this is of interest. I wanted something that generated inline docs using the wavedrom bitfield SVGs and with sections for the field descriptions.

An example conf.py:

peakrdl_input_files = ["regs.rdl"]
peakrdl_html_enable = False
peakrdl_doc_field_sections = True
image

This commit adds support for inline wavedrom bitfield rendering. Each
register gains an SVG view of the bit fields.  Adds a dependenc on
sphinxcontrib-yowasp-wavedrom.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant