| name | no-os-driver-readme |
| description | Write or update a no-OS device driver README.rst following the repo's standard driver-documentation structure. Use when creating documentation for a driver under drivers/<category>/<part>/, updating an existing driver README, or wiring a driver doc into the Sphinx toctree. |
no-OS Driver README
Generate or update drivers/<category>/<part>/README.rst files for the no-OS
repository so they match the house driver-documentation structure. These READMEs
are rendered on the docs site via a per-driver .. include:: stub and the
category glob toctree.
When to use
- Creating a
README.rst for a driver that lacks one.
- Rewriting an old driver README to the current structure.
- Wiring a new driver doc into the Sphinx build (stub + toctree check).
Inputs to gather first
Before writing, collect this. Ask the user only for what you cannot determine
from the repo or the device data sheet:
- Driver directory —
drivers/<category>/<part>/. Confirm it exists and
note the category (e.g. temperature, adc-dac, power, digital-io).
- Device(s) — part number(s) the driver supports and the ADI product
page(s). Multiple parts share one README when one driver covers them.
- Overview facts — resolution, channels, interface (SPI/I2C), supply
rails, key on-chip features, typical applications. Pull from the data sheet.
- Driver API surface — inspect the driver's public header
(
<part>.h) to list the functional groups and the <part>_* functions in
each (init, register access, measurement/conversion, channel config, GPIO,
diagnostics, ...). Group the docs the same way.
- — if the device is software-configurable into distinct
modes, capture them for the optional Operation Modes grid table.
