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