summaryrefslogtreecommitdiffstats
path: root/documentation/README
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-03-09 17:13:18 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-03-16 14:25:01 +0000
commit88e368dca48957314bca2a9a369dcde515953633 (patch)
treea83f5d116b906a4ba2c7751f05bc609c0fd6196f /documentation/README
parentbafbbd53c4591b420bc9f15aa1fe1bd4e1df88bb (diff)
downloadpoky-88e368dca48957314bca2a9a369dcde515953633.tar.gz
documentation/README: correct heading styles actually used in the YP manuals
Sphinx seems to offer flexibility in heading styles definitions, but the new text matches the way subsubsections and subsubsubsections are defined in the current manuals. Note that it's not possible to mix different definitions, for example by using "~~~~" and "^^^^" for subsubsections in different places. (From yocto-docs rev: 89a9af58adaa4cf4708d0383655b992f8c7239e2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/README')
-rw-r--r--documentation/README23
1 files changed, 12 insertions, 11 deletions
diff --git a/documentation/README b/documentation/README
index 123812dcac..6f6a8ec842 100644
--- a/documentation/README
+++ b/documentation/README
@@ -175,17 +175,18 @@ The layout of the Yocto Project manuals is organized as follows
175 Book 175 Book
176 Chapter 176 Chapter
177 Section 177 Section
178 Section 178 Subsection
179 Section 179 Subsubsection
180 180 Subsubsubsection
181Here are the heading styles defined in Sphinx: 181
182 182Here are the heading styles that we use in the manuals:
183 Book => overline === 183
184 Chapter => overline *** 184 Book => overline ===
185 Section => ==== 185 Chapter => overline ***
186 Section => ---- 186 Section => ====
187 Section => ^^^^ 187 Subsection => ----
188 Section => """" or ~~~~ 188 Subsubsection => ~~~~
189 Subsubsubsection => ^^^^
189 190
190With this proposal, we preserve the same TOCs between Sphinx and Docbook. 191With this proposal, we preserve the same TOCs between Sphinx and Docbook.
191 192