diff mbox series

[2/2] standards.md: update our admonitions encouraged usage

Message ID 20261029-admonitions-styling-v1-2-8990714284a1@bootlin.com
State New
Headers show
Series Rework admonition colors | expand

Commit Message

Antonin Godard Oct. 29, 2026, 12:58 p.m. UTC 
The previous commit sets the coloring for all Sphinx admonitions so that
they are consistent. This means we no longer need to limit the ones we
can use. Remove this limitations from the standards.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/standards.md | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)
diff mbox series

Patch

diff --git a/documentation/standards.md b/documentation/standards.md
index 30d48a5bb..496a1f003 100644
--- a/documentation/standards.md
+++ b/documentation/standards.md
@@ -111,8 +111,9 @@  glossary before or in the same patch it is used, so that `:term:` can be used.
 
 ### Admonitions
 
-Sphinx has predefined admonitions that can be used to highlight a bit of text or
-add a side-note to the documentation. For example:
+Sphinx has predefined [admonitions](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives)
+that can be used to highlight a bit of text or add a side-note to the
+documentation. For example:
 
 ```rst
 .. note::
@@ -120,10 +121,6 @@  add a side-note to the documentation. For example:
    This is a note admonition.
 ```
 
-We try to limit our usage of these admonitions to `note` and `warning`, as the
-Sphinx documentation [warns](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives)
-that most themes only style these two admonitions.
-
 ## ReStructured Text Syntax standards
 
 ### doc directive