diff mbox series

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

Message ID 20220309162422.616698-1-michael.opdenacker@bootlin.com
State New
Headers show
Series documentation/REAMDE: correct heading styles actually used in the YP manuals | expand

Commit Message

Michael Opdenacker March 9, 2022, 4:24 p.m. UTC 
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.

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/README | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)
diff mbox series

Patch

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.