OpenTitan UART sphinx-svdomain example

This project demonstrates sphinx-svdomain against a real hardware IP: the OpenTitan UART.

The rendered documentation is available at hardmatrix.github.io/sphinx-svdomain-example.

The vendored RTL logic is taken from lowRISC/opentitan@377160a7ea64bf6b187127db5f2bc6819b7ff196, with documentation comments added for autodoc. See rtl/README.md for provenance and the one parsing shim used by the example.

Build

Python 3.12 or newer and uv are required. From this directory:

uv sync
uv run sphinx-build -W --keep-going -b html docs _build/html

The generated site starts at _build/html/index.html. make html is available for a normal build without warning-as-error checking.