Skip to contentSkip to conversation

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

PATCH New Michael Opdenacker 1 participant 1 message Mar 9, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 documentation/REAMDE: 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.

---
 documentation/README | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)
documentation/README +12 -11
index 123812dcac..6f6a8ec842 100644
@@ -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.
 
Signature · 1 line
2.25.1