doc: boards: extensions: introduce zephyr:board role and directive #79994
Conversation
kartben
force-pushed
the
board_directive
branch
2 times, most recently
from
c641d80 to
b5c0361
Compare
kartben
changed the title
kartben
force-pushed
the
board_directive
branch
8 times, most recently
from
b8b4780 to
db19547
Compare
kartben
requested review from
erwango,
fabiobaltieri and
pdgendt
and removed request for
carlescufi
kartben
force-pushed
the
board_directive
branch
3 times, most recently
from
622c478 to
c446be7
Compare
There was a problem hiding this comment.
cool stuff, should the small image be linked to the full size image? we don't really do high res but looking at the page it's tempting to click (not even sure this is the right place to be honest, I'm talking about the board overview card in the board page https://builds.zephyrproject.io/zephyr/pr/79994/docs/boards/seeed/wio_terminal/doc/index.html)
There was a problem hiding this comment.
Ya it's the right place :) and yes, great suggestion
There was a problem hiding this comment.
Done!
Also fixed the styling of the <aside> on narrow screens (which I think might actually be a bug in RTD theme, btw, so I'll try to submit a fix upstream as well)
There was a problem hiding this comment.
which I think might actually be a bug in RTD theme, btw, so I'll try to submit a fix upstream as well
|
Just pushed a fix for a nasty bug that was causing Sphinx logs to be silenced - whoopsie. |
zephyrbot
requested review from
danieldegrasse,
dkalowsk,
jfischer-no and
mmahadevan108
fabiobaltieri
left a comment
fabiobaltieri
left a comment
There was a problem hiding this comment.
Great stuff can't wait to see how this renders in the pdf.
Fixes typos in Sphinx roles Signed-off-by: Benjamin Cabé <[email protected]>
Load the board catalog only once at build-inited time so that it's cached and enabled things like boards, vendors, and socs to eventually become first class Sphinx objects. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
dismissed stale reviews from sylvioalves and fabiobaltieri
via
d1c021b
kartben
force-pushed
the
board_directive
branch
from
4f6847e to
d1c021b
Compare
We don't include boards in the PDF 😝 |
|
Had to push one more commit to clean up 3.7 release notes re: Sphinx lint. |
kartben
requested review from
carlescufi,
erwango,
fabiobaltieri,
gmarull and
sylvioalves
A new zephyr:board:: Sphinx directive allows to flag a documentation page as being the documentation for a specific board, allowing to auto-populate some of the contents, ex. by adding a board overview a la Wikipedia, and later things like supported HW features, etc. A corresponding :zephyr:board: role allows to link to a board doc page. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Seeed Studio boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
force-pushed
the
board_directive
branch
from
d1c021b to
1e3aadd
Compare
gmarull
left a comment
gmarull
left a comment
There was a problem hiding this comment.
LGTM. It would be nice to start a mass cleanup of board pages. They contain tons of redundant information that just increases doc build time.
| * Added support for Ambiq Apollo3 series. | ||
| * Added support for multiple instances of the SPI NOR driver (spi_nor.c). | ||
| * Added preliminary support for non-erase devices with introduction of | ||
| device capabilities to c:struct:`flash_parameters` and the utility function |
There was a problem hiding this comment.
Kind of weird to be modifying release notes of an already finalized release.
10 participants
https://builds.zephyrproject.io/zephyr/pr/79994/docs/boards/seeed/wio_terminal/doc/index.html
https://builds.zephyrproject.io/zephyr/pr/79994/docs/contribute/documentation/guidelines.html#boards
A new
zephyr:board::Sphinx directive allows to flag a documentation page as being the documentation for a specific board, allowing to auto-populate some of the contents, ex. by adding a board overview à la Wikipedia, and later things like supported HW features, a ready-to-copy-paste example of how to build Hello World, etc.A corresponding
:zephyr:board:role allows to link to a board doc page.