diff options
Diffstat (limited to 'documentation/standards.md')
-rw-r--r-- | documentation/standards.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/documentation/standards.md b/documentation/standards.md index bc403e393e..f3d88d446b 100644 --- a/documentation/standards.md +++ b/documentation/standards.md | |||
@@ -109,6 +109,21 @@ or in the BitBake User Manual | |||
109 | If it is not described yet, the variable should be added to the | 109 | If it is not described yet, the variable should be added to the |
110 | glossary before or in the same patch it is used, so that `:term:` can be used. | 110 | glossary before or in the same patch it is used, so that `:term:` can be used. |
111 | 111 | ||
112 | ### Admonitions | ||
113 | |||
114 | Sphinx has predefined admonitions that can be used to highlight a bit of text or | ||
115 | add a side-note to the documentation. For example: | ||
116 | |||
117 | ```rst | ||
118 | .. note:: | ||
119 | |||
120 | This is a note admonition. | ||
121 | ``` | ||
122 | |||
123 | We try to limit our usage of these admonitions to `note` and `warning`, as the | ||
124 | Sphinx documentation [warns](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives) | ||
125 | that most themes only style these two admonitions. | ||
126 | |||
112 | ## ReStructured Text Syntax standards | 127 | ## ReStructured Text Syntax standards |
113 | 128 | ||
114 | This section has not been filled yet | 129 | This section has not been filled yet |