Re: [docs] YP docs should use more sphinx admonitions

On Mon, 29 Jun 2026, Quentin Schulz via lists.yoctoproject.org wrote:

> Hi Robert,
>
> On 6/26/26 10:13 PM, Robert P. J. Day via lists.yoctoproject.org wrote:
> >
> >    while there are *tons* of "note" admonitions in the YP docs, sphinx
> > supports a fair number of other admonitions that i think should get
> > more use:
> >
> > https://sphinx-book-theme.readthedocs.io/en/stable/reference/kitchen-sink/admonitions.html
> >
>
> Please only look at the official Sphinx documentation for things that are
> actually supported without additional Sphinx plugins.
>
> https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#admonitions-messages-and-warnings
>
> It's *very* often looking something up on search engines for something related
> to Sphinx to fall back to some third party plugin. While it's not necessarily
> bad, the fewer plugins we have the best :)

  ah, my mistake, thanks for clearing that up.

> For rST wikipedia says it's https://docutils.sourceforge.io/rst.html.
>
> But I feel like this is a good idea, I like Sphinx admonitions quite
> a lot.

  yeah, it seems like "Note" is the automatic go-to admonition when
sometimes a "Tip" or "Warning" would be more apppropriate.

rday