Skip to content

doc: pretty-printing I/O diagrams for shield pinouts, mikrobus expanders etc #88779

@cfriedt

Description

@cfriedt

Is your feature request related to a problem? Please describe.

it would be really nice to have an auto-generated I/O table like the one below, but for shields, mikrobus headers, booster pack connectors, and other types generated from devicetree much like .. zephyr:board-supported-hw::.

Image

The board-level documentation is looking really fantastic these days. Maybe there already is an implementation of this or a ticket, and I'm just not sure how to find it, but I feel like I haven't seen this kind of table where I would expect it.

Describe the solution you'd like
A macro like .. zephyr:board-shield-hw:: or something along those lines that can be used in Zephyr docs to generate a visually appealing diagram of "hat" pins or "shields" with respect to other board I/O pins.

Maybe it makes sense to specify an orientation with respect to another pin or something, so that both left and right pins, or top and bottom pins, can be daisy-chained?

Describe alternatives you've considered

Less visually appealing pinout tables like these.
Image

Additional context

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions