Re: Adding warning icon to warning admonitions?

From: Vegard Nossum
Date: Fri Jan 05 2024 - 13:12:59 EST



On 05/01/2024 15:59, Jonathan Corbet wrote:
Bagas Sanjaya <bagasdotme@xxxxxxxxx> writes:

For the icon itself, the approach is to use Font Awesome [2] (many other doc
sites that uses Sphinx also do that due to site theme they use but Alabaster
theme don't use the icon, hence this question). I personally prefer regular
icon variant (like in TT), but alas it is in non-free PRO plan (and only
solid variant is free and that is what Sphinx themes using).

Does adding warning icon like above idea make sense for the kernel docs? And
does it require non-trivial (complex) changes to Alabaster theme?

It can probably be done with a bit of CSS tweaking. I don't really like
the idea of requiring the installation of another font to build the
docs, though, and Font Awesome looks like it could bring in licensing
issues of its own - that's not clear from the site at all.

You could use the unicode symbol as a replacement for the graphic by
adding something like this to custom.css:

div.admonition.warning p.admonition-title::before {
content: "\26A0";
font-weight: bold;
font-size: 120%;
padding-right: 8px;
float: left;
}

It doesn't look great to me, but maybe with some additional tweaking it
could (e.g. text-stroke property, sizing, positioning, etc.).


Vegard