From 88e368dca48957314bca2a9a369dcde515953633 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Wed, 9 Mar 2022 17:13:18 +0100 Subject: 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 Signed-off-by: Richard Purdie --- documentation/README | 23 ++++++++++++----------- 1 file 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 Book Chapter Section - Section - Section - -Here are the heading styles defined in Sphinx: - - Book => overline === - Chapter => overline *** - Section => ==== - Section => ---- - Section => ^^^^ - Section => """" or ~~~~ + Subsection + Subsubsection + Subsubsubsection + +Here are the heading styles that we use in the manuals: + + Book => overline === + Chapter => overline *** + Section => ==== + Subsection => ---- + Subsubsection => ~~~~ + Subsubsubsection => ^^^^ With this proposal, we preserve the same TOCs between Sphinx and Docbook. -- cgit v1.2.3-54-g00ecf