mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-09-29 07:36:20 +02:00
Code Issues Packages Projects Releases Wiki Activity

standards.md: add a section on admonitions

Browse Source 
We try to limit our usage of these admonitions to `note` and `warning`,
as the Sphinx documentation warns that most themes only style these two
admonitions. So add a section on that.

Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 41788e6d230cfb49fadae58ab9651d57cc26f857)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit f86ffa1b1dcf0665c17424eee87b6bead09960f6)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
This commit is contained in:
Antonin Godard
2024-11-18 15:24:01 +01:00
committed by Steve Sakoman
parent a291343b4b
commit e4ba8cd69f
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
documentation/standards.md
View File

@@ -109,6 +109,21 @@ or in the BitBake User Manual
If it is not described yet, the variable should be added to the If it is not described yet, the variable should be added to the
glossary before or in the same patch it is used, so that `:term:` can be used. 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:
```rst
.. note::
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 ## ReStructured Text Syntax standards
This section has not been filled yet This section has not been filled yet