mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-01 06:32:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

documentation/README: correct heading styles actually used in the YP manuals

Browse Source 
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>
This commit is contained in:
Michael Opdenacker
2022-03-09 17:13:18 +01:00
committed by Richard Purdie
parent bafbbd53c4
commit 88e368dca4
1 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
documentation/README
View File

@@ -175,17 +175,18 @@ The layout of the Yocto Project manuals is organized as follows
Book
Chapter
Section
Section
Section
Subsection
Subsubsection
Subsubsubsection
Here are the heading styles defined in Sphinx:
Here are the heading styles that we use in the manuals:
Book => overline ===
Chapter => overline ***
Section => ====
Section => ----
Section => ^^^^
Section => """" or ~~~~
Book => overline ===
Chapter => overline ***
Section => ====
Subsection => ----
Subsubsection => ~~~~
Subsubsubsection => ^^^^
With this proposal, we preserve the same TOCs between Sphinx and Docbook.